Struct ics::Journal

pub struct Journal<'a>(_);

The VJOURNAL calendar component.

A Journal component is a grouping of component properties that represent one or more descriptive text notes associated with a particular calendar date. (see RFC5545 3.6.3. Journal Component)

Methods

impl<'a> Journal<'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 "VJOURNAL" calendar component. The "UID" and "DTSTAMP" properties are required. A UID should be generated randomly for security reasons.

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

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

Trait Implementations

impl<'a> PartialOrd<Journal<'a>> for Journal<'a>

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

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

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

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

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

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

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

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

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

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

impl<'a> PartialEq<Journal<'a>> for Journal<'a>

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

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

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

This method tests for !=.

impl<'a> Ord for Journal<'a>

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

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

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

Performs the conversion.

impl<'a> Clone for Journal<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<'a> Display for Journal<'a>

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

Formats the value using the given formatter.