Struct compact_calendar::CompactMonth

pub struct CompactMonth(_);

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

Implementations

impl CompactMonth

pub const fn new() -> Self

Create a new month that does not include any day.

use compact_calendar::CompactMonth;

let month = CompactMonth::new();
assert_eq!(month.count(), 0);

pub fn insert(&mut self, day: u32)

Include a day in this month.

use compact_calendar::CompactMonth;

let mut month = CompactMonth::new();
month.insert(2);
month.insert(2);
month.insert(19);
assert_eq!(month.count(), 2);

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

Check if this month includes the given day.

use compact_calendar::CompactMonth;

let mut month = CompactMonth::new();
month.insert(1);
month.insert(18);

assert!(month.contains(1));
assert!(month.contains(18));
assert!(!month.contains(5));

pub fn iter(self) -> impl Iterator<Item = u32>

Iterate over the days included in this month.

use compact_calendar::CompactMonth;

let mut month = CompactMonth::new();
month.insert(18);
month.insert(1);

let days: Vec<u32> = month.iter().collect();
assert_eq!(days, [1, 18])

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

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

use compact_calendar::CompactMonth;

let mut month = CompactMonth::new();
assert_eq!(month.first(), None);

month.insert(31);
assert_eq!(month.first(), Some(31));

month.insert(8);
assert_eq!(month.first(), Some(8));

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

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

use compact_calendar::CompactMonth;

let mut month = CompactMonth::new();
month.insert(4);
month.insert(17);

assert_eq!(month.first_after(2), Some(4));
assert_eq!(month.first_after(4), Some(17));
assert_eq!(month.first_after(17), None);

pub fn count(self) -> u32

Count number of days included for this month.

use compact_calendar::CompactMonth;

let mut month = CompactMonth::new();
month.insert(26);
month.insert(3);
assert_eq!(month.count(), 2);

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

Serialize this month into a writer.

use compact_calendar::CompactMonth;

let mut month = CompactMonth::new();

let mut buf1 = Vec::new();
month.insert(31);
month.serialize(&mut buf1).unwrap();

let mut buf2 = Vec::new();
month.insert(1);
month.serialize(&mut buf2).unwrap();

assert_ne!(buf1, buf2);

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

Deserialize a month from a reader.

use compact_calendar::CompactMonth;

let mut month1 = CompactMonth::new();
month1.insert(30);
month1.insert(2);

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

let month2 = CompactMonth::deserialize(buf.as_slice()).unwrap();
assert_eq!(month1, month2);

Trait Implementations

impl Clone for CompactMonth

fn clone(&self) -> CompactMonth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompactMonth

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

use compact_calendar::CompactMonth;

let mut month = CompactMonth::new();
month.insert(26);
month.insert(3);
assert_eq!(format!("{month:?}"), "{03, 26}");

impl Hash for CompactMonth

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for CompactMonth

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<CompactMonth> for CompactMonth

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<CompactMonth> for CompactMonth

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for CompactMonth

impl Eq for CompactMonth

impl StructuralEq for CompactMonth

impl StructuralPartialEq for CompactMonth