Struct clocksource::precise::AtomicDuration

pub struct AtomicDuration { /* private fields */ }

An atomic duration measured in nanoseconds.

A precise::AtomicDuration is a duration that is measured in nanoseconds and represented as an unsigned 64bit value. Since it is implemented using atomic primitives, it can be used when the duration needs interior mutability and atomic operations.

Implementations

impl AtomicDuration

pub fn new(value: Duration) -> Self

Create a new atomic duration.

pub fn from_secs(secs: u32) -> Self

Create a new atomic duration that represents the provided number of seconds.

pub fn from_nanos(nanos: u64) -> Self

Create a new atomic duration that represents the provided number of nanoseconds.

pub fn load(&self, ordering: Ordering) -> Duration

Loads the value of the duration.

See: core::sync::atomic::AtomicU64::load for a description of the memory orderings.

Panics

Panics if ordering is Release or AcqRel.

pub fn store(&self, value: Duration, ordering: Ordering)

Stores a new value for the duration.

See: core::sync::atomic::AtomicU64::store for a description of the memory orderings.

Panics

Panics if ordering is Acquire or AcqRel.

pub fn swap(&self, value: Duration, ordering: Ordering) -> Duration

Replaces the value of the duration and returns the previous value.

See: core::sync::atomic::AtomicU64::swap for a description of the memory orderings.

Note: This method is only available on platforms that support atomic operations on u64.

pub fn compare_exchange( &self, current: Duration, new: Duration, success: Ordering, failure: Ordering ) -> Result<Duration, Duration>

Stores a new value for the duration if the current duration is the same as the current duration.

See: core::sync::atomic::AtomicU64::compare_exchange for a description of the memory orderings.

Note: This method is only available on platforms that support atomic operations on u64.

pub fn compare_exchange_weak( &self, current: Duration, new: Duration, success: Ordering, failure: Ordering ) -> Result<Duration, Duration>

Stores a new value for the duration if the current duration is the same as the current duration.

See: core::sync::atomic::AtomicU64::compare_exchange_weak for a description of the memory orderings.

Unlike AtomicDuration::compare_exchange, this function is allowed to spuriously fail. This allows for more efficient code on some platforms.

Note: This method is only available on platforms that support atomic operations on u64.

pub fn fetch_add(&self, value: Duration, ordering: Ordering) -> Duration

Adds to the current duration, returning the previous duration.

This operation wraps around on overflow.

See: core::sync::atomic::AtomicU64::fetch_add for a description of the memory orderings.

Note: This method is only available on platforms that support atomic operations on u64.

pub fn fetch_max(&self, value: Duration, ordering: Ordering) -> Duration

Maximum with the current duration.

Finds the maximum of the current duration and the argument value, and sets the new duration to the result.

Returns the previous duration.

See: core::sync::atomic::AtomicU64::fetch_max for a description of the memory orderings.

Note: This method is only available on platforms that support atomic operations on u64.

pub fn fetch_min(&self, value: Duration, ordering: Ordering) -> Duration

Minimum with the current duration.

Finds the minimum of the current duration and the argument val, and sets the new duration to the result.

Returns the previous duration.

See: core::sync::atomic::AtomicU64::fetch_min for a description of the memory orderings.

Note: This method is only available on platforms that support atomic operations on u64.

pub fn fetch_sub(&self, value: Duration, ordering: Ordering) -> Duration

Subtracts from the current duration, returning the previous duration.

This operation wraps around on overflow.

See: core::sync::atomic::AtomicU64::fetch_sub for a description of the memory orderings.

Note: This method is only available on platforms that support atomic operations on u64.

Trait Implementations

impl Debug for AtomicDuration

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

Formats the value using the given formatter.

impl Default for AtomicDuration

fn default() -> AtomicDuration

Returns the “default value” for a type.

impl From<Duration> for AtomicDuration

fn from(other: Duration) -> Self

Converts to this type from the input type.

impl From<Duration> for AtomicDuration

fn from(other: Duration) -> Self

Converts to this type from the input type.

impl TryFrom<Duration> for AtomicDuration

type Error = TryFromError

The type returned in the event of a conversion error.

fn try_from(other: Duration) -> Result<Self, Self::Error>

Performs the conversion.