Struct Alarm

pub struct Alarm<'a>(/* private fields */);

The VALARM calendar sub-component of VEVENT and VTODO.

An Alarm component is a grouping of component properties that is a reminder or alarm for an Event or a ToDo. 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)

Implementations

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> 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> 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.

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

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

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialOrd 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> Eq for Alarm<'a>

impl<'a> StructuralPartialEq for Alarm<'a>