Skip to main content

TimeScale

Enum TimeScale 

Source
pub enum TimeScale {
    Years,
    Days,
    Hours,
    Minutes,
    Seconds,
    Milliseconds,
    Microseconds,
    Nanoseconds,
    Ratio(Ratio<NonZeroU32, NonZeroU32>),
}
Expand description

๐Ÿ•˜ Describes the conceptual scale at which time is expressed or interpreted.


๐Ÿ“ phys/time


TimeScale is lightweight, descriptive metadata. It can be used to label time sources, parameters, or policies without implying exact duration, normalization, or convertibility between scales.

Calendar-based variants (such as years or days) are symbolic and may depend on external conventions. The Ratio variant allows expressing custom scales relative to seconds.

Variantsยง

ยง

Years

ยง

Days

ยง

Hours

ยง

Minutes

ยง

Seconds

Default time scale.

ยง

Milliseconds

ยง

Microseconds

ยง

Nanoseconds

ยง

Ratio(Ratio<NonZeroU32, NonZeroU32>)

A custom, exact time scale expressed as a rational multiple of seconds.

Implementationsยง

Sourceยง

impl TimeScale

ยงAliases

Source

pub const Mins: Self = Self::Minutes

Alias for Minutes.

Source

pub const Secs: Self = Self::Seconds

Alias for Seconds.

Source

pub const Millis: Self = Self::Milliseconds

Alias for Milliseconds.

Source

pub const Micros: Self = Self::Microseconds

Alias for Microseconds.

Source

pub const Nanos: Self = Self::Nanoseconds

Alias for Nanoseconds.

Sourceยง

impl TimeScale

Source

pub const fn is_calendar(self) -> bool

Returns true if this scale is calendar-based.

Source

pub const fn is_fixed(self) -> bool

Returns true if this scale is not calendar-based.

Source

pub const fn is_subsecond(self) -> bool

Returns true if this scale is sub-second.

Source

pub const fn is_second_based(self) -> bool

Returns true if this scale is second-based or finer.

Source

pub const fn name(self) -> &'static str โ“˜

Returns a short, lowercase name for this time scale.

Source

pub const fn convert(self, value: u64, target: TimeScale) -> Option<u64> โ“˜

Converts a numeric value from this scale into target, if both scales have a fixed, exact ratio to seconds.

Returns None if either scale is calendar-based.

Source

pub fn convert_simulated(self, value: u64, target: TimeScale) -> u64

Converts a numeric value from this scale into target using fixed, simulation-friendly assumptions.

Calendar-based scales are treated as fixed-duration:

  • Days = 24 hours
  • Years = 365 days

This method never fails and is intended for testing, simulation, and synthetic time sources.

Sourceยง

impl TimeScale

Source

pub const fn new_ratio(num: u32, den: u32) -> Option<Self> โ“˜

Creates a ratio-based time scale relative to seconds.

Returns None if either component is zero.

Source

pub const fn some_ratio(self) -> Option<Ratio<NonZeroU32, NonZeroU32>> โ“˜

Returns the underlying ratio if this scale is already expressed as one.

Source

pub const fn to_ratio(self) -> Option<Ratio<NonZeroU32, NonZeroU32>> โ“˜

Returns the exact ratio of this scale relative to seconds, if fixed-duration.

The returned ratio expresses: 1 unit of this scale = num / den seconds

Calendar-based scales (Days, Years) return None.

Source

pub const fn to_ratio_simulated(self) -> Ratio<NonZeroU32, NonZeroU32>

Returns a simulation-friendly ratio of this scale relative to seconds.

The returned ratio expresses: 1 unit of this scale = num / den seconds

Unlike to_ratio, this method never fails. Calendar-based scales are mapped to fixed-duration approximations:

  • Days are treated as 24-hour days.
  • Years are treated as 365-day years.

This method is intended for testing, simulation, and synthetic time sources where deterministic behavior is preferred over civil-time accuracy.

Trait Implementationsยง

Sourceยง

impl Clone for TimeScale

Sourceยง

fn clone(&self) -> TimeScale

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) ยท Sourceยง

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

Performs copy-assignment from source. Read more
Sourceยง

impl Copy for TimeScale

Sourceยง

impl Debug for TimeScale

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Default for TimeScale

Sourceยง

fn default() -> TimeScale

Returns the โ€œdefault valueโ€ for a type. Read more
Sourceยง

impl Eq for TimeScale

Sourceยง

impl Hash for TimeScale

Sourceยง

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 ยท Sourceยง

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Sourceยง

impl PartialEq for TimeScale

Sourceยง

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) ยท Sourceยง

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

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

impl StructuralPartialEq for TimeScale

Auto Trait Implementationsยง

Blanket Implementationsยง

Sourceยง

impl<T> Any for T
where T: 'static + ?Sized,

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Sourceยง

impl<T> AnyExt for T
where T: Any + ?Sized,

Sourceยง

fn type_id() -> TypeId

Returns the TypeId of Self. Read more
Sourceยง

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more
Sourceยง

fn type_name(&self) -> &'static str โ“˜

Returns the type name of self. Read more
Sourceยง

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more
Sourceยง

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.
Sourceยง

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.
Sourceยง

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more
Sourceยง

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more
Sourceยง

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Available on crate feature alloc only.
Upcasts Box<self> as Box<dyn Any>. Read more
Sourceยง

fn downcast_ref<T: 'static>(&self) -> Option<&T> โ“˜

Available on crate feature unsafe_layout and non-crate feature safe_code only.
Returns some shared reference to the inner value if it is of type T. Read more
Sourceยง

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> โ“˜

Available on crate feature unsafe_layout and non-crate feature safe_code only.
Returns some exclusive reference to the inner value if it is of type T. Read more
Sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

Sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

Sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Sourceยง

impl<T> ByteSized for T

Sourceยง

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.
Sourceยง

const BYTE_SIZE: usize = _

The size of this type in bytes.
Sourceยง

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.
Sourceยง

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more
Sourceยง

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more
Sourceยง

impl<T> CloneToUninit for T
where T: Clone,

Sourceยง

unsafe fn clone_to_uninit(&self, dest: *mut u8)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
ยง

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

ยง

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

impl<T> Hook for T

Sourceยง

fn hook<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Hooks a mutation step into the value and returns it. Read more
Sourceยง

fn tap<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Taps into the value for observation and returns it unchanged. Read more
Sourceยง

impl<T, U> Into<U> for T
where U: From<T>,

Sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Sourceยง

impl<T> MemExt for T
where T: ?Sized,

Sourceยง

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.
Sourceยง

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more
Sourceยง

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more
Sourceยง

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more
Sourceยง

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more
Sourceยง

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more
Sourceยง

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more
Sourceยง

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more
Sourceยง

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more
Sourceยง

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more
Sourceยง

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more
Sourceยง

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more
Sourceยง

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Sourceยง

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Sourceยง

fn mem_as_bytes(&self) -> &[u8] โ“˜
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &[u8]. Read more
Sourceยง

fn mem_as_bytes_mut(&mut self) -> &mut [u8] โ“˜
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &mut [u8]. Read more
Sourceยง

impl<T, R> Morph<R> for T
where T: ?Sized,

Sourceยง

fn morph<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Morphs the value into a new one and returns it. Read more
Sourceยง

fn morph_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Morphs the value by shared reference and returns the result. Read more
Sourceยง

fn morph_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Morphs the value by exclusive reference and returns the result. Read more
Sourceยง

impl<T> ToOwned for T
where T: Clone,

Sourceยง

type Owned = T

The resulting type after obtaining ownership.
Sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
Sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> โ“˜

Performs the conversion.
Sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Sourceยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error> โ“˜

Performs the conversion.