Struct rrule::RRule

source · [−]

pub struct RRule { /* private fields */ }

Expand description

A validated Recurrence Rule that can be used to create an iterator.

Implementations

source

impl RRule

source

pub fn new(properties: RRuleProperties) -> Result<Self, RRuleError>

Create and validate the given properties and make sure they are valid before creating an RRule struct. If the properties are not valid it will return an error.

source

pub fn get_properties(&self) -> &RRuleProperties

Get the parameters set by the RRule.

Trait Implementations

source

impl Clone for RRule

source

fn clone(&self) -> RRule

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<'a> DateFilter<'a, RRuleIter<'a>> for RRule

source

fn all(&'a self, limit: u16) -> Result<Vec<DateTime<Tz>>, RRuleError>

Returns all the recurrences of the rrule. Read more

source

fn all_with_error(
&'a self,
limit: u16
) -> (Vec<DateTime<Tz>>, Option<RRuleError>)

Returns all the recurrences of the rrule. Read more

source

fn just_before(
 &'a self,
 before: DateTime<Tz>,
 inclusive: bool
) -> Result<Option<DateTime<Tz>>, RRuleError>

Returns the last recurrence before the given datetime instance. Read more

source

fn all_before_with_error(
 &'a self,
 before: DateTime<Tz>,
 inclusive: bool,
 limit: u16
) -> (Vec<DateTime<Tz>>, Option<RRuleError>)

Returns all the recurrences of the rrule before the given date. Read more

source

fn just_after(
 &'a self,
 after: DateTime<Tz>,
 inclusive: bool
) -> Result<Option<DateTime<Tz>>, RRuleError>

Returns the last recurrence after the given datetime instance. Read more

source

fn all_after_with_error(
 &'a self,
 after: DateTime<Tz>,
 inclusive: bool,
 limit: u16
) -> (Vec<DateTime<Tz>>, Option<RRuleError>)

Returns all the recurrences of the rrule after the given date. Read more

source

fn all_between(
 &'a self,
 start: DateTime<Tz>,
 end: DateTime<Tz>,
 inclusive: bool
) -> Result<Vec<DateTime<Tz>>, RRuleError>

Returns all the recurrences of the rrule between after and before. Read more

source

fn all_between_with_error(
 &'a self,
 start: DateTime<Tz>,
 end: DateTime<Tz>,
 inclusive: bool,
 limit: u16
) -> (Vec<DateTime<Tz>>, Option<RRuleError>)

Returns all the recurrences of the rrule after the given date and before the other date. Read more

source

impl Debug for RRule

source

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

Formats the value using the given formatter. Read more

source

impl FromStr for RRule

type Err = RRuleError

The associated error which can be returned from parsing.

source

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more

source

impl<'a> IntoIterator for &'a RRule

type Item = DateTime<Tz>

The type of the elements being iterated over.

type IntoIter = RRuleIter<'a>

Which kind of iterator are we turning this into?

source

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations

impl RefUnwindSafe for RRule

impl Send for RRule

impl Sync for RRule

impl Unpin for RRule

impl UnwindSafe for RRule

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct rrule::RRule

Implementations

impl RRule

pub fn new(properties: RRuleProperties) -> Result<Self, RRuleError>

pub fn get_properties(&self) -> &RRuleProperties

Trait Implementations

impl Clone for RRule

fn clone(&self) -> RRule

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

impl<'a> DateFilter<'a, RRuleIter<'a>> for RRule

fn all(&'a self, limit: u16) -> Result<Vec<DateTime<Tz>>, RRuleError>

fn all_with_error( &'a self, limit: u16) -> (Vec<DateTime<Tz>>, Option<RRuleError>)

fn just_before( &'a self, before: DateTime<Tz>, inclusive: bool) -> Result<Option<DateTime<Tz>>, RRuleError>

fn all_before_with_error( &'a self, before: DateTime<Tz>, inclusive: bool, limit: u16) -> (Vec<DateTime<Tz>>, Option<RRuleError>)

fn just_after( &'a self, after: DateTime<Tz>, inclusive: bool) -> Result<Option<DateTime<Tz>>, RRuleError>

fn all_after_with_error( &'a self, after: DateTime<Tz>, inclusive: bool, limit: u16) -> (Vec<DateTime<Tz>>, Option<RRuleError>)

fn all_between( &'a self, start: DateTime<Tz>, end: DateTime<Tz>, inclusive: bool) -> Result<Vec<DateTime<Tz>>, RRuleError>

fn all_between_with_error( &'a self, start: DateTime<Tz>, end: DateTime<Tz>, inclusive: bool, limit: u16) -> (Vec<DateTime<Tz>>, Option<RRuleError>)

impl Debug for RRule

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

impl FromStr for RRule

type Err = RRuleError

fn from_str(s: &str) -> Result<Self, Self::Err>

impl<'a> IntoIterator for &'a RRule

type Item = DateTime<Tz>

type IntoIter = RRuleIter<'a>

fn into_iter(self) -> Self::IntoIter

Auto Trait Implementations

impl RefUnwindSafe for RRule

impl Send for RRule

impl Sync for RRule

impl Unpin for RRule

impl UnwindSafe for RRule

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

fn all_with_error(
&'a self,
limit: u16
) -> (Vec<DateTime<Tz>>, Option<RRuleError>)

fn just_before(
&'a self,
before: DateTime<Tz>,
inclusive: bool
) -> Result<Option<DateTime<Tz>>, RRuleError>

fn all_before_with_error(
&'a self,
before: DateTime<Tz>,
inclusive: bool,
limit: u16
) -> (Vec<DateTime<Tz>>, Option<RRuleError>)

fn just_after(
&'a self,
after: DateTime<Tz>,
inclusive: bool
) -> Result<Option<DateTime<Tz>>, RRuleError>

fn all_after_with_error(
&'a self,
after: DateTime<Tz>,
inclusive: bool,
limit: u16
) -> (Vec<DateTime<Tz>>, Option<RRuleError>)

fn all_between(
&'a self,
start: DateTime<Tz>,
end: DateTime<Tz>,
inclusive: bool
) -> Result<Vec<DateTime<Tz>>, RRuleError>

fn all_between_with_error(
&'a self,
start: DateTime<Tz>,
end: DateTime<Tz>,
inclusive: bool,
limit: u16
) -> (Vec<DateTime<Tz>>, Option<RRuleError>)

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,