Struct PackedChineseBasedYearInfo

#[repr(C, packed(1))]
pub struct PackedChineseBasedYearInfo(pub u8, pub u8, pub u8);

The struct containing compiled ChineseData

Bit structure (little endian: note that shifts go in the opposite direction!)

Bit:             0   1   2   3   4   5   6   7
Byte 0:          [  month lengths .............
Byte 1:         .. month lengths ] | [ leap month index ..
Byte 2:          ] | [   NY offset       ] | unused

Where the New Year Offset is the offset from ISO Jan 21 of that year for Chinese New Year, the month lengths are stored as 1 = 30, 0 = 29 for each month including the leap month. The largest possible offset is 33, which requires 6 bits of storage.

🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways, including in SemVer minor releases. While the serde representation of data structs is guaranteed to be stable, their Rust representation might not be. Use with caution.

Tuple Fields

0: u8

1: u8

2: u8

Implementations

impl PackedChineseBasedYearInfo

pub(crate) const FIRST_NY: u8 = 19u8

The first day of the ISO year on which Chinese New Year may occur

According to Reingold & Dershowitz, ch 19.6, Chinese New Year occurs on Jan 21 - Feb 21 inclusive.

Chinese New Year in the year 30 AD is January 20 (30-01-20).

We allow it to occur as early as January 19 which is the earliest the second new moon could occur after the Winter Solstice if the solstice is pinned to December 20.

pub(crate) fn new( month_lengths: [bool; 13], leap_month_idx: Option<NonZeroU8>, ny_offset: u8, ) -> Self

pub(crate) fn ny_offset(self) -> u8

fn ny_day_of_iso_year(self) -> u8

The day of the year (1-indexed) that this is in the ISO year

pub(crate) fn ny_rd(self, related_iso: i32) -> RataDie

pub(crate) fn leap_month_idx(self) -> Option<NonZeroU8>

pub(crate) fn last_day_of_month(self, month: u8) -> u16

pub(crate) fn days_in_year(self) -> u16

Trait Implementations

impl AsULE for PackedChineseBasedYearInfo

type ULE = PackedChineseBasedYearInfo

The ULE type corresponding to Self.

fn to_unaligned(self) -> Self

Converts from Self to Self::ULE.

fn from_unaligned(other: Self) -> Self

Converts from Self::ULE to Self.

impl Clone for PackedChineseBasedYearInfo

fn clone(&self) -> PackedChineseBasedYearInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackedChineseBasedYearInfo

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

Formats the value using the given formatter.

impl Ord for PackedChineseBasedYearInfo

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PackedChineseBasedYearInfo

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for PackedChineseBasedYearInfo

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl ULE for PackedChineseBasedYearInfo

fn validate_byte_slice(bytes: &[u8]) -> Result<(), ZeroVecError>

Validates a byte slice, &[u8].

fn parse_byte_slice(bytes: &[u8]) -> Result<&[Self], ZeroVecError>

Parses a byte slice, &[u8], and return it as &[Self] with the same lifetime.

unsafe fn from_byte_slice_unchecked(bytes: &[u8]) -> &[Self]

Takes a byte slice, &[u8], and return it as &[Self] with the same lifetime, assuming that this byte slice has previously been run through Self::parse_byte_slice() with success.

fn as_byte_slice(slice: &[Self]) -> &[u8]

Given &[Self], returns a &[u8] with the same lifetime.

impl Copy for PackedChineseBasedYearInfo

impl Eq for PackedChineseBasedYearInfo

impl StructuralPartialEq for PackedChineseBasedYearInfo