Skip to main content

Wall

Struct Wall 

Source
pub struct Wall(/* private fields */);
Available on crate feature std only.
Expand description

A captured wall-clock instant.

Wall wraps a single sample of the operating system’s real-time clock. Convert it to Unix time with unix_seconds, unix_millis, or unix_nanos.

Wall and Monotonic are deliberately distinct types and cannot be mixed. If your system clock predates the Unix epoch (1970-01-01 UTC), the unix_* accessors saturate at zero — they never panic and never silently wrap.

Construct one with Wall::now or the crate-level wall shortcut.

§Examples

use clock_lib::Wall;

let stamp = Wall::now();
let seconds = stamp.unix_seconds();
assert!(seconds > 0);

Implementations§

Source§

impl Wall

Source

pub fn now() -> Self

Captures the current wall-clock time from the operating system.

This is the constructor for Wall. The crate-level wall function is a one-line shortcut for the same thing.

§Examples
use clock_lib::Wall;

let stamp = Wall::now();
Source

pub fn unix_seconds(self) -> u64

Returns Unix time in whole seconds.

Returns zero if the system clock is set to a moment before the Unix epoch. The return type is u64, which is sufficient to represent any plausible wall-clock value through year 584,942,417,355 — Unix time will not overflow this accessor.

§Examples
use clock_lib::Wall;

let seconds = Wall::now().unix_seconds();
assert!(seconds > 0);
Source

pub fn unix_millis(self) -> u128

Returns Unix time in whole milliseconds.

Returns zero if the system clock is set to a moment before the Unix epoch. The return type is u128, which cannot overflow for any representable SystemTime.

§Examples
use clock_lib::Wall;

let millis = Wall::now().unix_millis();
assert!(millis > 0);
Source

pub fn unix_nanos(self) -> u128

Returns Unix time in whole nanoseconds.

Returns zero if the system clock is set to a moment before the Unix epoch. The return type is u128, which cannot overflow for any representable SystemTime.

§Examples
use clock_lib::Wall;

let nanos = Wall::now().unix_nanos();
assert!(nanos > 0);

Trait Implementations§

Source§

impl Clone for Wall

Source§

fn clone(&self) -> Wall

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 Debug for Wall

Source§

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

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

impl Hash for Wall

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 Ord for Wall

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · 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 Wall

Source§

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

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · 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 (const: unstable) · 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 (const: unstable) · 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 (const: unstable) · 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 Wall

Source§

impl Eq for Wall

Source§

impl StructuralPartialEq for Wall

Auto Trait Implementations§

§

impl Freeze for Wall

§

impl RefUnwindSafe for Wall

§

impl Send for Wall

§

impl Sync for Wall

§

impl Unpin for Wall

§

impl UnsafeUnpin for Wall

§

impl UnwindSafe for Wall

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> 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.