Struct ics::Alarm

pub struct Alarm<'a>(_);

The VALARM calendar component, a sub-component for VEVENT and VTODO.

An Alarm component is a grouping of component properties that is a reminder or alarm for an event or a to-do. For example, it may be used to define a reminder for a pending event or an overdue to-do. (see RFC5545 3.6.6. Alarm Component)

Methods

impl<'a> Alarm<'a>

pub fn new(action: Action<'a>, trigger: Trigger<'a>) -> Self

Creates a new "VALARM" calendar component. The "ACTION" and "TRIGGER" properties are required.

pub fn audio(trigger: Trigger<'a>) -> Self

Creates a new audio alarm. The "TRIGGER" property is required.

pub fn display(trigger: Trigger<'a>, description: Description<'a>) -> Self

Creates a new display alarm. The "TRIGGER" and "DESCRIPTION" properties are required.

pub fn email(
    trigger: Trigger<'a>,
    description: Description<'a>,
    summary: Summary<'a>
) -> Self

Creates a new email alarm. The "TRIGGER", "DESCRIPTION" and "SUMMARY" properties are required.

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

Adds a property to the alarm. The RFC5545 specifies which property can be added depending on the kind of alarm.

Trait Implementations

impl<'a> PartialOrd<Alarm<'a>> for Alarm<'a>

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

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

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

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

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

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

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

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

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

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

impl<'a> PartialEq<Alarm<'a>> for Alarm<'a>

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

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

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

This method tests for !=.

impl<'a> Ord for Alarm<'a>

fn cmp(&self, other: &Alarm<'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> Eq for Alarm<'a>

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

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

Performs the conversion.

impl<'a> Clone for Alarm<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Hash for Alarm<'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> Debug for Alarm<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Alarm<'a>

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

Formats the value using the given formatter.