Trait icalendar::Component
[−]
[src]
pub trait Component { fn component_kind() -> &'static str; fn properties(&self) -> &HashMap<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<TZ: TimeZone>(&mut self, dt: DateTime<TZ>) -> &mut Self where TZ::Offset: Display { ... } fn ends<TZ: TimeZone>(&mut self, dt: DateTime<TZ>) -> &mut Self where TZ::Offset: Display { ... } 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 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) -> &HashMap<String, Property>
Allows access to the inner properties HashMap.
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
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<TZ: TimeZone>(&mut self, dt: DateTime<TZ>) -> &mut Self where TZ::Offset: Display
Set the DTSTART Property
fn ends<TZ: TimeZone>(&mut self, dt: DateTime<TZ>) -> &mut Self where TZ::Offset: Display
Set the DTEND Property
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
Defindes 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 class(&mut self, class: Class) -> &mut Self
Set the visibility class