Skip to main content

Subsecond

Struct Subsecond 

Source
pub struct Subsecond(/* private fields */);
Expand description

A high-precision representation of subsecond time with attosecond resolution.

Subsecond stores time values less than one second using six components: milliseconds, microseconds, nanoseconds, picoseconds, femtoseconds, and attoseconds. Each component is normalized to the range [0, 999].

The total precision is 10⁻¹⁸ seconds (one attosecond), providing sufficient accuracy for astronomical and high-precision timing applications.

Implementations§

Source§

impl Subsecond

Source

pub const ZERO: Subsecond

A constant representing zero subsecond time.

Source

pub const fn new() -> Subsecond

Creates a new Subsecond with all components set to zero.

§Examples
use lox_core::time::subsecond::Subsecond;

let s = Subsecond::new();
assert_eq!(s.as_attoseconds(), 0);
Source

pub const fn from_attoseconds(attoseconds: i64) -> Subsecond

Creates a Subsecond from a total number of attoseconds.

The input value is automatically normalized to the range [0, 10¹⁸) attoseconds (i.e., [0, 1) seconds). Values greater than or equal to one second wrap around, and negative values wrap from the top.

§Examples
use lox_core::time::subsecond::Subsecond;

let s = Subsecond::from_attoseconds(123456789123456789);
assert_eq!(s.milliseconds(), 123);
assert_eq!(s.microseconds(), 456);
assert_eq!(s.nanoseconds(), 789);

// Negative values wrap around
let s = Subsecond::from_attoseconds(-1);
assert_eq!(s.as_attoseconds(), 999999999999999999);
Source

pub const fn from_f64(value: f64) -> Option<Subsecond>

Source

pub const fn set_milliseconds(self, milliseconds: u32) -> Subsecond

Sets the millisecond component (10⁻³ seconds).

Values are automatically normalized to [0, 999] using modulo arithmetic. In debug builds, values >= 1000 trigger an assertion.

§Examples
use lox_core::time::subsecond::Subsecond;

let s = Subsecond::new().set_milliseconds(123);
assert_eq!(s.milliseconds(), 123);
Source

pub const fn set_microseconds(self, microseconds: u32) -> Subsecond

Sets the microsecond component (10⁻⁶ seconds).

Values are automatically normalized to [0, 999] using modulo arithmetic. In debug builds, values >= 1000 trigger an assertion.

Source

pub const fn set_nanoseconds(self, nanoseconds: u32) -> Subsecond

Sets the nanosecond component (10⁻⁹ seconds).

Values are automatically normalized to [0, 999] using modulo arithmetic. In debug builds, values >= 1000 trigger an assertion.

Source

pub const fn set_picoseconds(self, picoseconds: u32) -> Subsecond

Sets the picosecond component (10⁻¹² seconds).

Values are automatically normalized to [0, 999] using modulo arithmetic. In debug builds, values >= 1000 trigger an assertion.

Source

pub const fn set_femtoseconds(self, femtoseconds: u32) -> Subsecond

Sets the femtosecond component (10⁻¹⁵ seconds).

Values are automatically normalized to [0, 999] using modulo arithmetic. In debug builds, values >= 1000 trigger an assertion.

Source

pub const fn set_attoseconds(self, attoseconds: u32) -> Subsecond

Sets the attosecond component (10⁻¹⁸ seconds).

Values are automatically normalized to [0, 999] using modulo arithmetic. In debug builds, values >= 1000 trigger an assertion.

Source

pub const fn as_attoseconds(&self) -> i64

Converts the subsecond value to total attoseconds.

§Examples
use lox_core::time::subsecond::Subsecond;

let s = Subsecond::new().set_milliseconds(123).set_microseconds(456);
assert_eq!(s.as_attoseconds(), 123456000000000000);
Source

pub const fn as_seconds_f64(&self) -> f64

Converts the subsecond value to seconds as an f64.

§Examples
use lox_core::time::subsecond::Subsecond;

let s = Subsecond::new().set_milliseconds(500);
assert_eq!(s.as_seconds_f64(), 0.5);
Source

pub const fn milliseconds(&self) -> u32

Returns the millisecond component (10⁻³ seconds).

The returned value is always in the range [0, 999].

Source

pub const fn microseconds(&self) -> u32

Returns the microsecond component (10⁻⁶ seconds).

The returned value is always in the range [0, 999].

Source

pub const fn nanoseconds(&self) -> u32

Returns the nanosecond component (10⁻⁹ seconds).

The returned value is always in the range [0, 999].

Source

pub const fn picoseconds(&self) -> u32

Returns the picosecond component (10⁻¹² seconds).

The returned value is always in the range [0, 999].

Source

pub const fn femtoseconds(&self) -> u32

Returns the femtosecond component (10⁻¹⁵ seconds).

The returned value is always in the range [0, 999].

Source

pub const fn attoseconds(&self) -> u32

Returns the attosecond component (10⁻¹⁸ seconds).

The returned value is always in the range [0, 999].

Trait Implementations§

Source§

impl Clone for Subsecond

Source§

fn clone(&self) -> Subsecond

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Subsecond

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Subsecond

Source§

fn default() -> Subsecond

Returns the “default value” for a type. Read more
Source§

impl Display for Subsecond

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromStr for Subsecond

Source§

type Err = SubsecondParseError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Subsecond, <Subsecond as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Ord for Subsecond

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Subsecond

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 PartialOrd for Subsecond

Source§

fn partial_cmp(&self, other: &Subsecond) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for Subsecond

Source§

impl Eq for Subsecond

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> 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> 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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.