Trait Component

pub trait Component {
    // Required methods
    fn component_kind(&self) -> String;
    fn properties(&self) -> &BTreeMap<String, Property>;
    fn components(&self) -> &[Other];
    fn multi_properties(&self) -> &BTreeMap<String, Vec<Property>>;
    fn append_property(&mut self, property: impl Into<Property>) -> &mut Self;
    fn append_component(&mut self, child: impl Into<Other>) -> &mut Self;
    fn append_multi_property(
        &mut self,
        property: impl Into<Property>,
    ) -> &mut Self;

    // Provided methods
    fn property_value(&self, key: &str) -> Option<&str> { ... }
    fn fmt_write<W: Write>(&self, out: &mut W) -> Result<(), Error> { ... }
    fn to_string(&self) -> String { ... }
    fn try_into_string(&self) -> Result<String, Error> { ... }
    fn add_property(
        &mut self,
        key: impl Into<String>,
        val: impl Into<String>,
    ) -> &mut Self { ... }
    fn add_property_pre_alloc(&mut self, key: String, val: String) -> &mut Self { ... }
    fn add_multi_property(&mut self, key: &str, val: &str) -> &mut Self { ... }
    fn timestamp(&mut self, dt: DateTime<Utc>) -> &mut Self { ... }
    fn get_timestamp(&self) -> Option<DateTime<Utc>> { ... }
    fn get_start(&self) -> Option<DatePerhapsTime> { ... }
    fn get_end(&self) -> Option<DatePerhapsTime> { ... }
    fn priority(&mut self, priority: u32) -> &mut Self { ... }
    fn get_priority(&self) -> Option<u32> { ... }
    fn print(&self) -> Result<(), Error> { ... }
    fn summary(&mut self, desc: &str) -> &mut Self { ... }
    fn get_summary(&self) -> Option<&str> { ... }
    fn description(&mut self, desc: &str) -> &mut Self { ... }
    fn get_description(&self) -> Option<&str> { ... }
    fn uid(&mut self, uid: &str) -> &mut Self { ... }
    fn get_uid(&self) -> Option<&str> { ... }
    fn sequence(&mut self, sequence: u32) -> &mut Self { ... }
    fn get_sequence(&self) -> Option<u32> { ... }
    fn class(&mut self, class: Class) -> &mut Self { ... }
    fn get_class(&self) -> Option<Class> { ... }
    fn url(&mut self, url: &str) -> &mut Self { ... }
    fn get_url(&self) -> Option<&str> { ... }
    fn last_modified(&mut self, dt: DateTime<Utc>) -> &mut Self { ... }
    fn get_last_modified(&self) -> Option<DateTime<Utc>> { ... }
    fn created(&mut self, dt: DateTime<Utc>) -> &mut Self { ... }
    fn get_created(&self) -> Option<DateTime<Utc>> { ... }
}

Implemented by everything that goes into a Calendar

Required Methods

fn component_kind(&self) -> String

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 components(&self) -> &[Other]

Allows access to the inner’s child components.

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

Read-only access to multi_properties

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

Append a given Property

fn append_component(&mut self, child: impl Into<Other>) -> &mut Self

Append a given Component

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

Adds a Property of which there may be many

Provided Methods

fn property_value(&self, key: &str) -> Option<&str>

Gets the value of a property.

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

Writes Component using std::fmt.

fn to_string(&self) -> String

Serializes this component into rfc5545 again

Panic

this can panic if std::fmt::write returns an Error use Component::try_into_string() if you don’t like panicking

fn try_into_string(&self) -> Result<String, Error>

Serializes this component into rfc5545 again

fn add_property( &mut self, key: impl Into<String>, val: impl Into<String>, ) -> &mut Self

Construct and append a Property

fn add_property_pre_alloc(&mut self, key: String, val: String) -> &mut Self

👎Deprecated

Construct and append a Property

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

Construct and append a Property

fn timestamp(&mut self, dt: DateTime<Utc>) -> &mut Self

Set the DTSTAMP Property

This must be a UTC date-time value.

fn get_timestamp(&self) -> Option<DateTime<Utc>>

Gets the DTSTAMP property.

fn get_start(&self) -> Option<DatePerhapsTime>

Gets the DTSTART Property

fn get_end(&self) -> Option<DatePerhapsTime>

Gets the DTEND Property

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

Defines the relative priority.

Ranges from 0 to 10, larger values will be truncated

fn get_priority(&self) -> Option<u32>

Gets the relative priority.

Ranges from 0 to 10.

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

Prints to stdout

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

Set the summary

fn get_summary(&self) -> Option<&str>

Gets the summary

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

Set the description

fn get_description(&self) -> Option<&str>

Gets the description

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

Set the UID

fn get_uid(&self) -> Option<&str>

Gets the UID

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

Set the sequence

fn get_sequence(&self) -> Option<u32>

Gets the SEQUENCE

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

Set the visibility class

fn get_class(&self) -> Option<Class>

Gets the visibility class

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

Sets the URL.

fn get_url(&self) -> Option<&str>

Gets the URL.

fn last_modified(&mut self, dt: DateTime<Utc>) -> &mut Self

Set the LAST_MODIFIED Property

This must be a UTC date-time value.

fn get_last_modified(&self) -> Option<DateTime<Utc>>

Gets the LAST_MODIFIED property.

fn created(&mut self, dt: DateTime<Utc>) -> &mut Self

Set the CREATED Property

This must be a UTC date-time value.

fn get_created(&self) -> Option<DateTime<Utc>>

Gets the CREATED property.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Component for Alarm

impl Component for Event

impl Component for Todo

impl Component for Venue