Struct two_timer::Config

pub struct Config { /* private fields */ }

A collection of parameters that can influence the interpretation of time expressions.

Implementations

impl Config

pub fn new() -> Config

Constructs an expression with the default parameters.

pub fn now(&self, n: NaiveDateTime) -> Config

Returns a copy of the configuration parameters with the “now” moment set to the parameter supplied.

pub fn monday_starts_week(&self, monday_starts_week: bool) -> Config

Returns a copy of the configuration parameters with whether Monday is regarded as the first day of the week set to the parameter supplied. By default Monday is regarded as the first day. If this parameter is set to false, Sunday will be regarded as the first weekday.

pub fn pay_period_length(&self, pay_period_length: u32) -> Config

Returns a copy of the configuration parameters with the pay period length in days set to the parameter supplied. The default pay period length is 7 days.

pub fn pay_period_start(&self, pay_period_start: Option<NaiveDate>) -> Config

Returns a copy of the configuration parameters with the reference start date for a pay period set to the parameter supplied. By default this date is undefined. Unless it is defined, expressions containing the phrase “pay period” or “pp” cannot be interpreted.

pub fn default_to_past(&self, default_to_past: bool) -> Config

Returns a copy of the configuration parameters with the default_to_past parameter set as specified. This allows the interpretation of relative time expressions like “Friday” and “12:00”. By default, these expressions are assumed to refer to the most recent such interval in the past. By setting default_to_past to false the rule changes so they are assumed to refer to the nearest such interval in the future.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.