Skip to main content

ClockErrorBoundV2

Struct ClockErrorBoundV2 

Source
pub struct ClockErrorBoundV2 { /* private fields */ }
Expand description

Structure that holds the ClockErrorBound data captured at a specific point in time and valid until a subsequent point in time.

The ClockErrorBound structure supports calculating the actual bound on clock error at any time, using its now() method. The internal fields are not meant to be accessed directly.

Note that the timestamps in between which this ClockErrorBound data is valid are captured using a CLOCK_MONOTONIC_COARSE clock. The monotonic clock id is required to correctly measure the duration during which clock drift possibly accrues, and avoid events when the clock is set, smeared or affected by leap seconds.

The structure is shared across the Shared Memory segment and has a C representation to enforce this specific layout.

Implementations§

Source§

impl ClockErrorBoundV2

Source

pub fn new( as_of: TimeSpec, void_after: TimeSpec, bound_nsec: i64, disruption_marker: u64, max_drift_ppb: u32, clock_status: ClockStatus, clock_disruption_support_enabled: bool, ) -> ClockErrorBoundV2

Create a new ClockErrorBound struct.

Source

pub fn now(&self) -> Result<ClockBoundNowResult, ShmError>

The ClockErrorBoundV2 implementation of now(), a clock_gettime() equivalent but with bound on clock accuracy.

Returns a pair of (earliest, latest) timespec between which current time exists. The interval width is twice the clock error bound (ceb) such that: (earliest, latest) = ((now - ceb), (now + ceb)) The function also returns a clock status to assert that the clock is being synchronized, or free-running, or …

Trait Implementations§

Source§

impl ClockBoundSnapshot for ClockErrorBoundV2

Source§

fn now(&self) -> Result<ClockBoundNowResult, ShmError>

The ClockErrorBoundV2 implementation of now().

This version relies on the system clock to retrieve the current time as well as grow the bound on the clock error at a constant rate.

Source§

impl Clone for ClockErrorBoundV2

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 ClockErrorBoundV2

Source§

impl Debug for ClockErrorBoundV2

Source§

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

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

impl PartialEq for ClockErrorBoundV2

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 StructuralPartialEq for ClockErrorBoundV2

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. 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> 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 = !

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

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more