Skip to main content

Schedule

Struct Schedule 

Source
pub struct Schedule { /* private fields */ }
Expand description

Describe a full schedule for a day, keeping track of open, closed and unknown periods.

It can be turned into an iterator which will yield consecutive ranges of different states, with no holes or overlapping.

Implementations§

Source§

impl Schedule

Source

pub fn new() -> Self

Creates a new empty schedule, which represents an always closed period.

use opening_hours::schedule::Schedule;

assert!(Schedule::new().is_empty());
Source

pub fn from_ranges( ranges: impl IntoIterator<Item = Range<ExtendedTime>>, kind: RuleKind, comments: &UniqueSortedVec<Arc<str>>, ) -> Self

Create a new schedule from a list of ranges of same kind and comment.

use opening_hours::schedule::Schedule;
use opening_hours_syntax::{ExtendedTime, RuleKind};

let sch1 = Schedule::from_ranges(
    [
        ExtendedTime::new(10, 0).unwrap()..ExtendedTime::new(14, 0).unwrap(),
        ExtendedTime::new(12, 0).unwrap()..ExtendedTime::new(16, 0).unwrap(),
    ],
    RuleKind::Open,
    &Default::default(),
);

let sch2 = Schedule::from_ranges(
    [ExtendedTime::new(10, 0).unwrap()..ExtendedTime::new(16, 0).unwrap()],
    RuleKind::Open,
    &Default::default(),
);

assert_eq!(sch1, sch2);
Source

pub fn is_empty(&self) -> bool

Check if a schedule is empty.

use opening_hours::schedule::Schedule;

assert!(Schedule::new().is_empty());
Source

pub fn addition(self, other: Self) -> Self

Merge two schedules together.

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
Source§

impl Default for Schedule

Source§

fn default() -> Schedule

Returns the “default value” for a type. Read more
Source§

impl IntoIterator for Schedule

Source§

type Item = TimeRange

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for Schedule

Source§

fn eq(&self, other: &Schedule) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Schedule

Source§

impl StructuralPartialEq for Schedule

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.