Struct Interval 

pub struct Interval<Tz>
where
    Tz: TimeZone,
{
    start: DateTime<Tz>,
    end: DateTime<Tz>,
}

Available on crate feature time only.

Half-open time interval.

The interval is defined two DateTimes [start, end), where start is inclusive and end is exclusive.

The interval is modelled after the ISO 8601 time interval format, but it only supports the fully qualified start/end format.

Format

The string representation is in the format <start>/<end>, where both <start> and <end> are full RFC 3339 date-time strings. No other ISO 8601 formats are supported.

If the serde feature is enabled, the type can be serialized and deserialized as a string in this format.

Fields

start: DateTime<Tz>

end: DateTime<Tz>

Implementations

impl<Tz> Interval<Tz>

where Tz: TimeZone,

pub fn new(start: DateTime<Tz>, end: DateTime<Tz>) -> Option<Interval<Tz>>

Creates a new interval from start and end datetimes.

Returns None if the end is before the start.

pub const fn start(&self) -> &DateTime<Tz>

Returns the start of the interval.

pub const fn end(&self) -> &DateTime<Tz>

Returns the end of the interval.

pub const fn time_delta(&self) -> TimeDelta

Returns the duration of the interval as a TimeDelta.

The return value is always non-negative since start <= end.

pub const fn duration(&self) -> Duration

Returns the duration of the interval as a Duration.

pub fn contains(&self, dt: DateTime<Tz>) -> bool

Returns true if a datetime is within the interval.

pub fn order_datetime(&self, dt: DateTime<Tz>) -> Ordering

Compares a datetime with the interval.

Returns:

• Less if the datetime is before the start of the interval,
• Greater if the datetime is after the end of the interval,
• Equal if the datetime is within the interval.

pub fn checked_add_days(self, days: Days) -> Option<Interval<Tz>>

Returns a new interval that is shifted by the given number of days.

Returns None if either start or end returns None when adding the days. See DateTime::checked_add_days for the conditions.

Trait Implementations

impl<Tz> Clone for Interval<Tz>

where Tz: Clone + TimeZone,

fn clone(&self) -> Interval<Tz>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Tz> Debug for Interval<Tz>

where Tz: Debug + TimeZone,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Interval<FixedOffset>

fn deserialize<D>( deserializer: D, ) -> Result<Interval<FixedOffset>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Tz> Display for Interval<Tz>

where Tz: TimeZone, <Tz as TimeZone>::Offset: Display,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl FromStr for Interval<FixedOffset>

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<Interval<FixedOffset>, <Interval<FixedOffset> as FromStr>::Err>

Parses a string s to return a value of this type.

impl<Tz> Serialize for Interval<Tz>

where Tz: TimeZone, <Tz as TimeZone>::Offset: Display,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.