Struct ics::ICalendar

pub struct ICalendar<'a>(_);

The iCalendar object specified as VCALENDAR.

An ICalendar consists of calendar properties and one or more calendar components. Properties are attributes that apply to the calendar object as a whole. (see RFC5545 3.4 iCalendar Object) The ICalendar struct can be thought of as the iCalendar object. This is where the specified components are added. To save the object as file, it needs to be written to a file.

Methods

impl<'a> ICalendar<'a>

pub fn new<V, P>(version: V, prodid: P) -> Self where
    V: Into<Cow<'a, str>>,
    P: Into<Cow<'a, str>>, 

Creates a new iCalendar object/"VCALENDAR" calendar component. The "VERSION" and "PRODID" properties are required.

pub fn push<P>(&mut self, property: P) where
    P: Into<Property<'a>>, 

Adds a property to the iCalendar object. Calendar properties are like calendar attributes.

pub fn add_component<C>(&mut self, component: C) where
    C: Into<Component<'a>>, 

Adds a Component to the iCalendar object. This should be only used for IANA/non-standard components.

pub fn add_event(&mut self, event: Event<'a>)

Adds an Event component to the iCalendar object.

pub fn add_todo(&mut self, todo: ToDo<'a>)

Adds a ToDo component to the iCalendar object.

pub fn add_journal(&mut self, journal: Journal<'a>)

Adds a Journal component to the iCalendar object.

pub fn add_freebusy(&mut self, freebusy: FreeBusy<'a>)

Adds a FreeBusy component to the iCalendar object.

pub fn add_timezone(&mut self, timezone: TimeZone<'a>)

Adds a TimeZone component to the iCalendar object.

pub fn write<W>(&self, writer: W) -> Result<()> where
    W: Write, 

Generic convenience method to write the content of the iCalendar object to a writer in the iCalendar format.

pub fn save_file<P>(&self, filename: P) -> Result<()> where
    P: AsRef<Path>, 

Creates a file from the path and saves the content of the iCalendar object in the iCalendar format inside the file.

Trait Implementations

impl<'a> Ord for ICalendar<'a>

fn cmp(&self, other: &ICalendar<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a> Clone for ICalendar<'a>

fn clone(&self) -> ICalendar<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Eq for ICalendar<'a>

impl<'a> From<ICalendar<'a>> for Component<'a>

fn from(component: ICalendar<'a>) -> Self

Performs the conversion.

impl<'a> PartialEq<ICalendar<'a>> for ICalendar<'a>

fn eq(&self, other: &ICalendar<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ICalendar<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<ICalendar<'a>> for ICalendar<'a>

fn partial_cmp(&self, other: &ICalendar<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ICalendar<'a>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ICalendar<'a>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ICalendar<'a>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ICalendar<'a>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Hash for ICalendar<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a> Display for ICalendar<'a>

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

Formats the value using the given formatter.

impl<'a> Debug for ICalendar<'a>

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

Formats the value using the given formatter.