Struct IniSessionDate 

pub struct IniSessionDate { /* private fields */ }

A Gregorian date that Dear ImGui can round-trip through ImGuiPackedDate.

Dear ImGui stores the year in seven bits as an offset from 2000, with zero reserved for an invalid date. The safe range is therefore 2001 through 2127 inclusive.

Implementations

impl IniSessionDate

pub fn new(year: u16, month: u8, day: u8) -> Result<Self, IniSessionDateError>

Creates a date that is representable by Dear ImGui’s packed .ini format.

pub const fn year(self) -> u16

Returns the calendar year.

pub const fn month(self) -> u8

Returns the calendar month in the range 1 through 12.

pub const fn day(self) -> u8

Returns the day of month.

pub const fn as_yyyymmdd(self) -> u32

Returns the YYYYMMDD representation consumed by Dear ImGui.

pub const fn max_auto_discard_months(self) -> u16

Returns the largest safe automatic-discard period for this date.

Dear ImGui subtracts whole months without guarding the packed year against underflow.

Trait Implementations

impl Clone for IniSessionDate

fn clone(&self) -> IniSessionDate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for IniSessionDate

impl Debug for IniSessionDate

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

Formats the value using the given formatter.

impl Display for IniSessionDate

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

Formats the value using the given formatter.

impl Eq for IniSessionDate

impl From<IniSessionDate> for u32

fn from(value: IniSessionDate) -> Self

Converts to this type from the input type.

impl Hash for IniSessionDate

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 IniSessionDate

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for IniSessionDate

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

impl TryFrom<u32> for IniSessionDate

type Error = IniSessionDateError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.