Enum icalendar::CalendarDateTime

pub enum CalendarDateTime {
    Floating(NaiveDateTime),
    Utc(DateTime<Utc>),
    WithTimezone {
        date_time: NaiveDateTime,
        tzid: String,
    },
}

Representation of various forms of DATE-TIME per RFC 5545, Section 3.3.5

Conversions from chrono types are provided in form of From implementations, see documentation of individual variants.

In addition to readily implemented FORM #1 and FORM #2, the RFC also specifies FORM #3: DATE WITH LOCAL TIME AND TIME ZONE REFERENCE. This variant is not yet implemented. Adding it will require adding support for VTIMEZONE and referencing it using TZID.

Variants

Floating(NaiveDateTime)

FORM #1: DATE WITH LOCAL TIME: floating, follows current time-zone of the attendee.

Conversion from chrono::NaiveDateTime results in this variant.

Note

finding this in a calendar is a red flag, datetimes should end in 'Z' for UTC or have a TZID property

Utc(DateTime<Utc>)

FORM #2: DATE WITH UTC TIME: rendered with Z suffix character.

Conversion from chrono::DateTime<Utc> results in this variant. Use date_time.with_timezone(&Utc) to convert date_time from arbitrary time zone to UTC.

WithTimezone

FORM #3: DATE WITH LOCAL TIME AND TIME ZONE REFERENCE: refers to a time zone definition.

Fields

date_time: NaiveDateTime

The date and time in the given time zone.

tzid: String

The ID of the time zone definition in a VTIMEZONE calendar component.

Implementations

impl CalendarDateTime

pub fn try_into_utc(&self) -> Option<DateTime<Utc>>

attempts to convert the into UTC

pub fn from_ymd_hm_tzid( year: i32, month: u32, day: u32, hour: u32, min: u32, tz_id: Tz, ) -> Option<Self>

will return None if date is not valid

pub fn from_date_time<TZ: TimeZone<Offset = O>, O: OffsetName>( dt: DateTime<TZ>, ) -> Self

Create a new instance with the given timezone

Trait Implementations

impl Clone for CalendarDateTime

fn clone(&self) -> CalendarDateTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CalendarDateTime

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

Formats the value using the given formatter.

impl From<(NaiveDateTime, Tz)> for CalendarDateTime

fn from((date_time, tzid): (NaiveDateTime, Tz)) -> Self

Converts to this type from the input type.

impl From<CalendarDateTime> for DatePerhapsTime

fn from(dt: CalendarDateTime) -> Self

Converts to this type from the input type.

impl From<DateTime<Utc>> for CalendarDateTime

Converts from time zone-aware UTC date-time to CalendarDateTime::Utc.

fn from(dt: DateTime<Utc>) -> Self

Converts to this type from the input type.

impl From<NaiveDateTime> for CalendarDateTime

Converts from time zone-less date-time to CalendarDateTime::Floating.

fn from(dt: NaiveDateTime) -> Self

Converts to this type from the input type.

impl FromStr for CalendarDateTime

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl PartialEq for CalendarDateTime

fn eq(&self, other: &CalendarDateTime) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<(NaiveDateTime, &str)> for CalendarDateTime

type Error = String

The type returned in the event of a conversion error.

fn try_from((dt, maybe_tz): (NaiveDateTime, &str)) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for CalendarDateTime

impl StructuralPartialEq for CalendarDateTime