Struct icalendar::Alarm

pub struct Alarm { /* private fields */ }

VALARM (RFC 5545, Section 3.6.6 )

Alarms can be added to Events and Todos. An alarm always has a Trigger and an Action. The Trigger describes when the alarm should happen and the Action describes what should happen.

Triggers

An alarm can either be triggered at an absolute time or in relation to its event, so the Trigger can either be an absolute CalendarDateTime or a Duration plus a relation tag, which defines wether the duration is related to the events start or end.

Action

When it is time for the Alarm to occur we have to define what is actually supposed to happen. The RFC5545 know three different actions, two of which are currently implemented.

1. Display
2. Audio
3. Email (not yet implemented)

 // alarm will occur one minute from now
 let event_with_absolute_audio_alarm = Event::new()
     .alarm(
         Alarm::audio(Utc::now() + Duration::minutes(1))
         .duration_and_repeat(Duration::minutes(1), 4)
     )
     .done();

 // alarm will occur one minute before the start
 let event_with_relative_display_alarm = Event::new()
     .alarm(
         Alarm::display("ALARM! ALARM!", -Duration::minutes(1))
         .duration_and_repeat(Duration::minutes(1), 4)
     )
     .done();

 // alarm will occur one minute before the end
 let event_with_relative_display_alarm_end = Event::new()
     .alarm(
         Alarm::display("ALARM! ALARM!", (-Duration::minutes(1), Related::End))
         .duration_and_repeat(Duration::minutes(1), 4)
     )
     .done();

Implementations

impl Alarm

pub fn audio<T: Into<Trigger>>(trigger: T) -> Self

Creates a new Audio- Alarm Component

Definition

‘action’ and ‘trigger’ are both REQUIRED, but MUST NOT occur more than once.

action / trigger /

‘duration’ and ‘repeat’ are both OPTIONAL, and MUST NOT occur more than once each; but if one occurs, so MUST the other.

duration / repeat /

The following is OPTIONAL, but MUST NOT occur more than once.

attach /

The following is OPTIONAL, and MAY occur more than once.

x-prop / iana-prop

pub fn display(description: &str, trigger: impl Into<Trigger>) -> Self

Creates a new Display- Alarm Component

Definition

The following are REQUIRED, but MUST NOT occur more than once.

action / description / trigger /

‘duration’ and ‘repeat’ are both OPTIONAL, and MUST NOT occur more than once each; but if one occurs, so MUST the other.

duration / repeat /

The following is OPTIONAL, and MAY occur more than once.

x-prop / iana-prop

pub fn duration_and_repeat<R: Copy + Clone + Into<Repeat>>( self, duration: Duration, repeat_count: R ) -> Self

Sets duration the REPEAT and DURATION property, which must not occur independent from one another

pub fn done(&mut self) -> Self

End of builder pattern. copies over everything

Trait Implementations

impl Clone for Alarm

fn clone(&self) -> Alarm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Alarm

fn component_kind(&self) -> String

Tells you what kind of Component this is

Might be VEVENT, VTODO, VALARM etc

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

Read-only access to properties

fn components(&self) -> &[Other]

Read-only access to properties

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

Adds a Property

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

Adds a Property of which there may be many

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

Append a given Component

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

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

Serializes this component into rfc5545 again

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

Construct and append a Property

fn add_property_pre_alloc(&mut self, key: String, val: String) -> &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 timestamp(&mut self, dt: DateTime<Utc>) -> &mut Self

Set the DTSTAMP Property

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.

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

Gets the relative priority.

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.

impl Debug for Alarm

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

Formats the value using the given formatter.

impl PartialEq for Alarm

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

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

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

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

impl TryInto<String> for Alarm

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<String, Self::Error>

Performs the conversion.

impl Eq for Alarm

impl StructuralPartialEq for Alarm