Skip to main content

ClockId

Struct ClockId 

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

Clock identifier

Newtype pattern around libc::clockid_t.

Implementations§

Source§

impl ClockId

Source

pub const CLOCK_BOOTTIME: ClockId

Available on linux_android or Emscripten or FreeBSD or Fuchsia or OpenBSD only.

Starts at zero when the kernel boots and increments monotonically in SI seconds while the machine is running.

Source

pub const CLOCK_BOOTTIME_ALARM: ClockId

Available on linux_android or Emscripten or Fuchsia only.

Like CLOCK_BOOTTIME, but will wake the system if it is suspended..

Source

pub const CLOCK_MONOTONIC: ClockId

Increments in SI seconds.

Source

pub const CLOCK_MONOTONIC_COARSE: ClockId

Available on linux_android or Emscripten or FreeBSD or Fuchsia only.

Like CLOCK_MONOTONIC, but optimized for execution time at the expense of accuracy.

Source

pub const CLOCK_MONOTONIC_RAW: ClockId

Available on linux_android or Emscripten or Fuchsia only.

Similar to CLOCK_MONOTONIC, but provides access to a raw hardware-based time that is not subject to NTP adjustments.

Source

pub const CLOCK_PROCESS_CPUTIME_ID: ClockId

Available on apple_targets or freebsdlike or linux_android or netbsdlike or Emscripten or Fuchsia or Redox OS only.

Returns the execution time of the calling process.

Source

pub const CLOCK_REALTIME: ClockId

Increments as a wall clock should.

Source

pub const CLOCK_REALTIME_ALARM: ClockId

Available on linux_android or Emscripten or Fuchsia only.

Like CLOCK_REALTIME, but not settable.

Source

pub const CLOCK_REALTIME_COARSE: ClockId

Available on linux_android or Emscripten or FreeBSD or Fuchsia only.

Like CLOCK_REALTIME, but optimized for execution time at the expense of accuracy.

Source

pub const CLOCK_TAI: ClockId

Available on linux_android or Emscripten or Fuchsia only.

International Atomic Time.

A nonsettable system-wide clock derived from wall-clock time but ignoring leap seconds.

Source

pub const CLOCK_THREAD_CPUTIME_ID: ClockId

Available on apple_targets or freebsdlike or linux_android or netbsdlike or Emscripten or Fuchsia only.

Returns the execution time of the calling thread.

Source

pub const fn from_raw(clk_id: clockid_t) -> Self

Creates ClockId from raw clockid_t

Source

pub fn pid_cpu_clock_id(pid: Pid) -> Result<Self>

Available on crate feature process only.

Returns ClockId of a pid CPU-time clock

Source

pub fn res(self) -> Result<TimeSpec>

Available on non-Redox OS only.

Returns resolution of the clock id

Source

pub fn now(self) -> Result<TimeSpec>

Returns the current time on the clock id

Source

pub fn set_time(self, timespec: TimeSpec) -> Result<()>

Available on neither Hermit nor iOS nor Redox OS nor tvOS nor watchOS.

Sets time to timespec on the clock id

Source

pub const fn as_raw(self) -> clockid_t

Gets the raw clockid_t wrapped by self

Trait Implementations§

Source§

impl Clone for ClockId

Source§

fn clone(&self) -> Self

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 ClockId

Source§

impl Debug for ClockId

Source§

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

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

impl Display for ClockId

Source§

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

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

impl Eq for ClockId

Source§

impl From<ClockId> for clockid_t

Source§

fn from(clock_id: ClockId) -> Self

Converts to this type from the input type.
Source§

impl From<i32> for ClockId

Source§

fn from(clk_id: clockid_t) -> Self

Converts to this type from the input type.
Source§

impl Hash for ClockId

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 ClockId

Source§

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

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for ClockId

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for ClockId

Source§

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for ClockId

Auto Trait Implementations§

§

impl Freeze for ClockId

Available on Unix only.
§

impl RefUnwindSafe for ClockId

Available on Unix only.
§

impl Send for ClockId

Available on Unix only.
§

impl Sync for ClockId

Available on Unix only.
§

impl Unpin for ClockId

Available on Unix only.
§

impl UnsafeUnpin for ClockId

Available on Unix only.
§

impl UnwindSafe for ClockId

Available on Unix only.

Blanket Implementations§

Source§

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

Available on Unix only.
Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Available on Unix only.
Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Available on Unix only.
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,

Available on Unix only.
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

Available on Unix only.
Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Available on Unix only.
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,

Available on Unix only.
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,

Available on Unix only.
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>,

Available on Unix only.
Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Available on Unix only.
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.