Struct PackedIslamicYearInfo

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

The struct containing compiled Islamic YearInfo

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:         .. months    ] | [ ny offset    ]

Where the New Year Offset is a signed offset from epoch + MEAN_SYNODIC_MONTH * year * 12 for the given calendar. This number does not appear to be less than 2, however we use all remaining bits for it in case of drift in the math. The month lengths are stored as 1 = 30, 0 = 29 for each month including the leap month.

🚧 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

Implementations

impl PackedIslamicYearInfo

pub(crate) fn new(month_lengths: [bool; 12], ny_offset: i8) -> Self

fn month_lengths(self) -> [u8; 12]

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

pub(crate) fn ny<IB: IslamicBasedMarker>(self, extended_year: i32) -> RataDie

pub(crate) fn month_has_30_days(self, month: u8) -> bool

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

The number of days in a given 1-indexed month

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

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

pub(crate) fn compute_with_ny<IB: IslamicBasedMarker>( extended_year: i32, ny: RataDie, ) -> Self

Trait Implementations

impl AsULE for PackedIslamicYearInfo

type ULE = PackedIslamicYearInfo

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 PackedIslamicYearInfo

fn clone(&self) -> PackedIslamicYearInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackedIslamicYearInfo

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

Formats the value using the given formatter.

impl Hash for PackedIslamicYearInfo

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PackedIslamicYearInfo

fn cmp(&self, other: &PackedIslamicYearInfo) -> 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 PackedIslamicYearInfo

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

fn partial_cmp(&self, other: &PackedIslamicYearInfo) -> 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 PackedIslamicYearInfo

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 PackedIslamicYearInfo

impl Eq for PackedIslamicYearInfo

impl StructuralPartialEq for PackedIslamicYearInfo