CompactYear

Struct CompactYear 

Source
pub struct CompactYear(/* private fields */);
Expand description

A compact representation of included days for a year, using a collection of u32-based bit array.

Implementations§

Source§

impl CompactYear

Source

pub fn insert(&mut self, month: u32, day: u32) -> bool

Include a day in this year. Return false if the day was already included.

use compact_calendar::CompactYear;

let mut year = CompactYear::default();
year.insert(11, 3);
year.insert(11, 3);
year.insert(1, 25);
assert_eq!(year.count(), 2);
Source

pub fn contains(&self, month: u32, day: u32) -> bool

Check if this year includes the given day.

use compact_calendar::CompactYear;

let mut year = CompactYear::default();
year.insert(3, 1);
year.insert(9, 5);

assert!(year.contains(3, 1));
assert!(year.contains(9, 5));
assert!(!year.contains(7, 14));
Source

pub fn iter(&self) -> impl Iterator<Item = (u32, u32)> + '_

Iterate over the days included in this year.

use compact_calendar::CompactYear;

let mut year = CompactYear::default();
year.insert(9, 5);
year.insert(3, 1);

let days: Vec<_> = year.iter().collect();
assert_eq!(days, [(3, 1), (9, 5)])
Source

pub fn first(&self) -> Option<(u32, u32)>

Get the first day included in this year if it is not empty.

use compact_calendar::CompactYear;

let mut year = CompactYear::default();
assert_eq!(year.first(), None);

year.insert(12, 31);
assert_eq!(year.first(), Some((12, 31)));

year.insert(5, 8);
assert_eq!(year.first(), Some((5, 8)));
Source

pub fn first_after(&self, month: u32, day: u32) -> Option<(u32, u32)>

Get the first day included in this year that follows the input day, if such a day exists.

use compact_calendar::CompactYear;

let mut year = CompactYear::default();
year.insert(3, 15);
year.insert(10, 9);
year.insert(2, 7);

assert_eq!(year.first_after(2, 2), Some((2, 7)));
assert_eq!(year.first_after(2, 7), Some((3, 15)));
assert_eq!(year.first_after(11, 1), None);
Source

pub fn count(&self) -> u32

Count number of days included for this year.

use compact_calendar::CompactYear;

let mut year = CompactYear::default();
year.insert(11, 3);
year.insert(4, 28);
assert_eq!(year.count(), 2);
Source

pub fn serialize(&self, writer: impl Write) -> Result<()>

Serialize this year into a writer.

use compact_calendar::CompactYear;

let mut year = CompactYear::default();

let mut buf1 = Vec::new();
year.insert(11, 3);
year.serialize(&mut buf1).unwrap();

let mut buf2 = Vec::new();
year.insert(4, 28);
year.serialize(&mut buf2).unwrap();

assert_ne!(buf1, buf2);
Source

pub fn deserialize(reader: impl Read) -> Result<Self>

Deserialize a year from a reader.

use compact_calendar::CompactYear;

let mut year1 = CompactYear::default();
year1.insert(11, 3);
year1.insert(4, 28);

let mut buf = Vec::new();
year1.serialize(&mut buf).unwrap();

let year2 = CompactYear::deserialize(buf.as_slice()).unwrap();
assert_eq!(year1, year2);

Trait Implementations§

Source§

impl Clone for CompactYear

Source§

fn clone(&self) -> CompactYear

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 CompactYear

Source§

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

use compact_calendar::CompactYear;

let mut year = CompactYear::default();
year.insert(11, 3);
year.insert(4, 28);
assert_eq!(format!("{year:?}"), "{04-28, 11-03}");
Source§

impl Default for CompactYear

Source§

fn default() -> Self

Create a new year that does not include any day.

use compact_calendar::CompactYear;

let year = CompactYear::default();
assert_eq!(year.count(), 0);
Source§

impl Hash for CompactYear

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for CompactYear

Source§

fn cmp(&self, other: &CompactYear) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for CompactYear

Source§

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

Source§

fn partial_cmp(&self, other: &CompactYear) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for CompactYear

Source§

impl Eq for CompactYear

Source§

impl StructuralPartialEq for CompactYear

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.