Struct Event

pub struct Event<'a> { /* private fields */ }

The VEVENT calendar component

An Event component is a grouping of component properties, possibly including an Alarm, that represents a scheduled amount of time on a calendar. (see RFC5545 3.6.1. Event Component)

Implementations

impl<'a> Event<'a>

pub fn new<U, D>(uid: U, dtstamp: D) -> Self

where U: Into<Cow<'a, str>>, D: Into<Cow<'a, str>>,

Creates a new VEVENT calendar component. The UID and DTSTAMP properties are required. A UID should be generated randomly for security reasons.

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

Adds a property to the event. RFC5545 and RFC7986 specify which properties can be added to an event.

pub fn add_alarm(&mut self, alarm: Alarm<'a>)

Adds a VALARM to the event.

Trait Implementations

impl<'a> Clone for Event<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Event<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Event<'a>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

fn eq(&self, other: &Event<'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 Event<'a>

fn partial_cmp(&self, other: &Event<'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 Event<'a>

impl<'a> StructuralPartialEq for Event<'a>