Struct Daily 

pub struct Daily { /* private fields */ }

A recurrence pattern for daily events which may also include fixed times of the day.

Example

use recurring::pattern::Daily;
use jiff::civil::time;

let every_two_days_at_twelve = Daily::new(1).at(time(12, 0, 0, 0));

Implementations

impl Daily

pub fn new<I: ToSpan>(interval: I) -> Daily

Creates a new Daily from an interval of days.

The fallible version of this method is Daily::try_new.

Panics

Panics if interval is negative or zero.

Example

use recurring::pattern::Daily;

let every_two_days = Daily::new(2);

pub fn try_new<I: ToSpan>(interval: I) -> Result<Daily, Error>

Creates a new Daily from an interval of days.

The panicking version of this method is Daily::new.

Errors

Returns an Error if interval is negative or zero.

Example

use recurring::pattern::Daily;

assert!(Daily::try_new(1).is_ok());
assert!(Daily::try_new(0).is_err());
assert!(Daily::try_new(-1).is_err());

pub fn at<T: Into<Time>>(self, time: T) -> Daily

Sets the exact time of day for the daily recurrence.

Example

use jiff::civil::time;
use recurring::pattern::daily;

let every_day_at_twelve = daily(1).at(time(12, 0, 0, 0));

let every_day_at_midnight_and_twelve = every_day_at_twelve.at(time(0, 0, 0, 0));

Trait Implementations

impl Clone for Daily

fn clone(&self) -> Daily

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Daily

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

Formats the value using the given formatter.

impl PartialEq for Daily

fn eq(&self, other: &Daily) -> 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 Pattern for Daily

fn next_after( &self, instant: DateTime, range: DateTimeRange, ) -> Option<DateTime>

Find the next DateTime after instant within a range.

fn previous_before( &self, instant: DateTime, range: DateTimeRange, ) -> Option<DateTime>

Find the previous DateTime before instant within a range.

fn closest_to( &self, instant: DateTime, range: DateTimeRange, ) -> Option<DateTime>

Find a DateTime closest to instant within a range.

impl Eq for Daily

impl StructuralPartialEq for Daily