[−][src]Trait icalendar::Component

pub trait Component {
    fn component_kind() -> &'static str;

    fn properties(&self) -> &BTreeMap<String, Property>;

    fn multi_properties(&self) -> &Vec<Property>;

    fn append_property(&mut self, property: Property) -> &mut Self;

    fn append_multi_property(&mut self, property: Property) -> &mut Self;

    fn fmt_write<W: Write>(&self, out: &mut W) -> Result<(), Error> { ... }

    fn to_string(&self) -> String { ... }

    fn add_property(&mut self, key: &str, val: &str) -> &mut Self { ... }

    fn add_multi_property(&mut self, key: &str, val: &str) -> &mut Self { ... }

    fn starts<T: Into<CalendarDateTime>>(&mut self, dt: T) -> &mut Self { ... }

    fn ends<T: Into<CalendarDateTime>>(&mut self, dt: T) -> &mut Self { ... }

    fn start_date<TZ: TimeZone>(&mut self, date: Date<TZ>) -> &mut Self
    where
        TZ::Offset: Display,
    { ... }

    fn end_date<TZ: TimeZone>(&mut self, date: Date<TZ>) -> &mut Self
    where
        TZ::Offset: Display,
    { ... }

    fn all_day<TZ: TimeZone>(&mut self, date: Date<TZ>) -> &mut Self
    where
        TZ::Offset: Display,
    { ... }

    fn priority(&mut self, priority: u32) -> &mut Self { ... }

    fn print(&self) -> Result<(), Error> { ... }

    fn summary(&mut self, desc: &str) -> &mut Self { ... }

    fn description(&mut self, desc: &str) -> &mut Self { ... }

    fn location(&mut self, location: &str) -> &mut Self { ... }

    fn venue(&mut self, location: &str, venue_uid: &str) -> &mut Self { ... }

    fn uid(&mut self, uid: &str) -> &mut Self { ... }

    fn class(&mut self, class: Class) -> &mut Self { ... }
}

Implemented by everything that goes into a Calendar

Required methods

fn component_kind() -> &'static str

Returns kind of component.

Must be ALL CAPS These are used in the BEGIN and END line of the component.

fn properties(&self) -> &BTreeMap<String, Property>

Allows access to the inner properties map.

fn multi_properties(&self) -> &Vec<Property>

Read-only access to multi_properties

fn append_property(&mut self, property: Property) -> &mut Self

Append a given Property

fn append_multi_property(&mut self, property: Property) -> &mut Self

Adds a Property of which there may be many

Loading content...

Provided methods

fn fmt_write<W: Write>(&self, out: &mut W) -> Result<(), Error>

Writes Component into a Writer using std::fmt.

fn to_string(&self) -> String

Guess what

fn add_property(&mut self, key: &str, val: &str) -> &mut Self

Construct and append a Property

fn add_multi_property(&mut self, key: &str, val: &str) -> &mut Self

Construct and append a Property

fn starts<T: Into<CalendarDateTime>>(&mut self, dt: T) -> &mut Self

Set the DTSTART Property

See CalendarDateTime for info how are different chrono types converted automatically.

fn ends<T: Into<CalendarDateTime>>(&mut self, dt: T) -> &mut Self

Set the DTEND Property

See CalendarDateTime for info how are different chrono types converted automatically.

fn start_date<TZ: TimeZone>(&mut self, date: Date<TZ>) -> &mut Self where
    TZ::Offset: Display, 

Set the DTSTART Property, date only

fn end_date<TZ: TimeZone>(&mut self, date: Date<TZ>) -> &mut Self where
    TZ::Offset: Display, 

Set the DTEND Property, date only

fn all_day<TZ: TimeZone>(&mut self, date: Date<TZ>) -> &mut Self where
    TZ::Offset: Display, 

Set the DTSTART Property, date only

fn priority(&mut self, priority: u32) -> &mut Self

Defines the relative priority.

Ranges from 0 to 10, larger values will be truncated

fn print(&self) -> Result<(), Error>

Prints to stdout

fn summary(&mut self, desc: &str) -> &mut Self

Set the summary

fn description(&mut self, desc: &str) -> &mut Self

Set the description

fn location(&mut self, location: &str) -> &mut Self

Set the LOCATION 3.8.1.7. Location

fn venue(&mut self, location: &str, venue_uid: &str) -> &mut Self

Set the LOCATION with a VVENUE UID iCalender venue draft

fn uid(&mut self, uid: &str) -> &mut Self

Set the UID

fn class(&mut self, class: Class) -> &mut Self

Set the visibility class

Loading content...

Implementors

impl Component for Event[src]

fn component_kind() -> &'static str[src]

Tells you what kind of Component this is

Might be VEVENT, VTODO, VALARM etc

fn properties(&self) -> &BTreeMap<String, Property>[src]

Read-only access to properties

fn multi_properties(&self) -> &Vec<Property>[src]

Read-only access to multi_properties

fn append_property(&mut self, property: Property) -> &mut Self[src]

Adds a Property

fn append_multi_property(&mut self, property: Property) -> &mut Self[src]

Adds a Property of which there may be many

impl Component for Todo[src]

fn component_kind() -> &'static str[src]

Tells you what kind of Component this is

Might be VEVENT, VTODO, VALARM etc

fn properties(&self) -> &BTreeMap<String, Property>[src]

Read-only access to properties

fn multi_properties(&self) -> &Vec<Property>[src]

Read-only access to multi_properties

fn append_property(&mut self, property: Property) -> &mut Self[src]

Adds a Property

fn append_multi_property(&mut self, property: Property) -> &mut Self[src]

Adds a Property of which there may be many

impl Component for Venue[src]

fn component_kind() -> &'static str[src]

Tells you what kind of Component this is

Might be VEVENT, VTODO, VALARM etc

fn properties(&self) -> &BTreeMap<String, Property>[src]

Read-only access to properties

fn multi_properties(&self) -> &Vec<Property>[src]

Read-only access to multi_properties

fn append_property(&mut self, property: Property) -> &mut Self[src]

Adds a Property

fn append_multi_property(&mut self, property: Property) -> &mut Self[src]

Adds a Property of which there may be many

Loading content...