Enum greg::real::Scale

pub enum Scale {
    Seconds,
    Minutes,
    Hours,
    Days,
    Weeks,
    Months,
    Years,
}

Timescale

This enum represents various “scales” of time, and with the exception of Scale::Years and Scale::Months they are precisely defined as a number of seconds. For Scale::Years and Scale::Months such a precise definition is obviously not available. Nonetheless, it is often useful to treat them as a concrete number of seconds, such as when formatting a time Span not anchored to a particular Point in time. For a human to comprehend a long length of time, it’s better to express it in terms of years and months, instead of just weeks, which is the highest precisely defined Scale, even if that is somewhat ill-defined. To do this, the Scale must be expressed as a fixed number of seconds (a Span).
There are a few different values that could reasonably be chosen for the length of Scale::Years and Scale::Months respectively. This library simply copies helper types of std::chrono::duration provided in C++ since C++20.
Accordingly, “years is equal to 365.2425 days (the average length of a Gregorian year)” and “months is equal to 30.436875 days (exactly 1/12 of years)”. Conveniently, both of these work out to an integral number of seconds.

Scale	unit	seconds
Years	y	31556952
Months	mo	2629746
Weeks	w	604800
Days	d	86400
Hours	h	3600
Minutes	m	60
Seconds	s	1

All this is not to say that a Scale represents just a specific number of seconds. For instance, the Calendar::date_floor and Calendar::frames functions use it with “calendar semantics”.

Variants

Seconds

Minutes

Hours

Days

Weeks

Months

Years

Implementations

impl Scale

pub const fn as_seconds(self) -> u64

The (average) amount of seconds, see Scale for details

Trait Implementations

impl Clone for Scale

fn clone(&self) -> Scale

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scale

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

Formats the value using the given formatter.

impl Div<Scale> for Span

type Output = u64

The resulting type after applying the / operator.

fn div(self, rhs: Scale) -> Self::Output

Performs the / operation.

impl From<Scale> for Span

fn from(scale: Scale) -> Self

Converts to this type from the input type.

impl Hash for Scale

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 Scale

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Scale

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

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

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

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

impl PartialOrd for Scale

fn partial_cmp(&self, other: &Scale) -> 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 Rem<Scale> for Span

type Output = Span

The resulting type after applying the % operator.

fn rem(self, rhs: Scale) -> Self::Output

Performs the % operation.

impl Copy for Scale

impl Eq for Scale

impl StructuralEq for Scale

impl StructuralPartialEq for Scale