Schedule

Enum Schedule 

Source
pub enum Schedule {
    Hours {
        start_hour: u8,
        end_hour: u8,
        use_local_tz: bool,
    },
    Weekdays {
        use_local_tz: bool,
    },
    Weekends {
        use_local_tz: bool,
    },
    Custom(Arc<dyn Fn(DateTime<Utc>) -> bool + Send + Sync>),
}
Expand description

A time-based schedule for constraint checking.

Variants§

§

Hours

Business hours (e.g., 9am-5pm). When use_local_tz is true, hours are interpreted in the system’s local timezone. When false, hours are interpreted in UTC.

Fields

§start_hour: u8
§end_hour: u8
§use_local_tz: bool
§

Weekdays

Monday through Friday. When use_local_tz is true, weekday is determined in the system’s local timezone. When false, weekday is determined in UTC.

Fields

§use_local_tz: bool
§

Weekends

Saturday and Sunday. When use_local_tz is true, weekday is determined in the system’s local timezone. When false, weekday is determined in UTC.

Fields

§use_local_tz: bool
§

Custom(Arc<dyn Fn(DateTime<Utc>) -> bool + Send + Sync>)

Custom schedule using a closure.

Implementations§

Source§

impl Schedule

Source

pub fn hours(start_hour: u8, end_hour: u8) -> Result<Self>

Create a business hours schedule (UTC).

For local timezone-aware schedules, use hours_local_tz().

§Errors

Returns an error if:

  • start_hour is greater than 23
  • end_hour is greater than 23
  • start_hour is greater than or equal to end_hour
§Examples
use tiny_counter::Schedule;

let schedule = Schedule::hours(9, 17).unwrap();  // 9am-5pm UTC
let schedule = Schedule::hours(6, 22).unwrap();  // 6am-10pm UTC
let schedule = Schedule::hours_local_tz(9, 17).unwrap();  // 9am-5pm local time
Source

pub fn hours_local_tz(start_hour: u8, end_hour: u8) -> Result<Self>

Create a business hours schedule using the system’s local timezone.

§Errors

Returns an error if:

  • start_hour is greater than 23
  • end_hour is greater than 23
  • start_hour is greater than or equal to end_hour
§Examples
use tiny_counter::Schedule;

let schedule = Schedule::hours_local_tz(9, 17).unwrap();  // 9am-5pm in system's local timezone
Source

pub fn weekdays() -> Self

Create a weekdays schedule (Monday-Friday, UTC).

Source

pub fn weekdays_local_tz() -> Self

Create a weekdays schedule using the system’s local timezone.

Source

pub fn weekends() -> Self

Create a weekends schedule (Saturday-Sunday, UTC).

Source

pub fn weekends_local_tz() -> Self

Create a weekends schedule using the system’s local timezone.

Trait Implementations§

Source§

impl Clone for Schedule

Source§

fn clone(&self) -> Schedule

Returns a duplicate 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 Debug for Schedule

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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,

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.