pub struct Alarm<'a>(_);
Expand description
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
sourceimpl<'a> Alarm<'a>
impl<'a> Alarm<'a>
sourcepub fn new(action: Action<'a>, trigger: Trigger<'a>) -> Self
pub fn new(action: Action<'a>, trigger: Trigger<'a>) -> Self
Creates a new VALARM
calendar component. The ACTION
and TRIGGER
properties are required.
sourcepub fn audio(trigger: Trigger<'a>) -> Self
pub fn audio(trigger: Trigger<'a>) -> Self
Creates a new audio alarm. The TRIGGER
property is required.
sourcepub fn display(trigger: Trigger<'a>, description: Description<'a>) -> Self
pub fn display(trigger: Trigger<'a>, description: Description<'a>) -> Self
Creates a new display alarm. The TRIGGER
and DESCRIPTION
properties
are required.
sourcepub fn email(
trigger: Trigger<'a>,
description: Description<'a>,
summary: Summary<'a>
) -> Self
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.
Trait Implementations
sourceimpl<'a> Ord for Alarm<'a>
impl<'a> Ord for Alarm<'a>
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl<'a> PartialOrd<Alarm<'a>> for Alarm<'a>
impl<'a> PartialOrd<Alarm<'a>> for Alarm<'a>
sourcefn partial_cmp(&self, other: &Alarm<'a>) -> Option<Ordering>
fn partial_cmp(&self, other: &Alarm<'a>) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moreimpl<'a> Eq for Alarm<'a>
impl<'a> StructuralEq for Alarm<'a>
impl<'a> StructuralPartialEq for Alarm<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for Alarm<'a>
impl<'a> Send for Alarm<'a>
impl<'a> Sync for Alarm<'a>
impl<'a> Unpin for Alarm<'a>
impl<'a> UnwindSafe for Alarm<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more