Enum TimeUnit

pub enum TimeUnit {
    NanoSecond,
    MicroSecond,
    MilliSecond,
    Second,
    Minute,
    Hour,
    Day,
    Week,
    Month,
    Year,
}

The time units used to define possible time units in the input string

The parser calculates the final Duration based on the parsed number and time unit. Each TimeUnit has an inherent Multiplier and a default id. The Multiplier influences the final value of the Duration and is seconds based. See also the documentation of Multiplier

Examples

use fundu_core::time::Multiplier;
use fundu_core::time::TimeUnit::*;

assert_eq!(NanoSecond.default_identifier(), "ns");
assert_eq!(Second.default_identifier(), "s");
assert_eq!(Hour.default_identifier(), "h");

assert_eq!(NanoSecond.multiplier(), Multiplier(1, -9));
assert_eq!(MilliSecond.multiplier(), Multiplier(1, -3));
assert_eq!(Second.multiplier(), Multiplier(1, 0));
assert_eq!(Hour.multiplier(), Multiplier(60 * 60, 0));

Variants

NanoSecond

Represents the lowest possible time unit. The default id is given by DEFAULT_ID_NANO_SECOND = ns

MicroSecond

The default id is given by DEFAULT_ID_MICRO_SECOND = Ms

MilliSecond

The default id is given by DEFAULT_ID_MILLI_SECOND = ms

Second

The default if no time unit is given. The default id is given by DEFAULT_ID_SECOND = s

Minute

The default id is given by DEFAULT_ID_MINUTE = m

Hour

The default id is given by DEFAULT_ID_HOUR = h

Day

The default id is given by DEFAULT_ID_DAY = d

Week

The default id is given by DEFAULT_ID_WEEK = w

Month

The default id is given by DEFAULT_ID_MONTH = M

Year

Represents the hightest possible time unit. The default id is given by DEFAULT_ID_YEAR = y

Implementations

impl TimeUnit

pub const fn default_identifier(&self) -> &'static str

Return the default identifier

pub const fn multiplier(&self) -> Multiplier

Return the base Multiplier of this TimeUnit.

This multiplier is always seconds based so for example:

NanoSecond: Multiplier(1, -9)
Second: Multiplier(1, 0)
Year: Multiplier(31557600, 0)

Trait Implementations

impl Clone for TimeUnit

fn clone(&self) -> TimeUnit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeUnit

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

Formats the value using the given formatter.

impl Default for TimeUnit

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimeUnit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for TimeUnit

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 TimeUnit

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TimeUnit

impl Eq for TimeUnit

impl StructuralPartialEq for TimeUnit