Skip to main content

ClockErrorBoundGenericBuilder

Struct ClockErrorBoundGenericBuilder 

Source
pub struct ClockErrorBoundGenericBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build_internal().

Implementations§

Source§

impl<S: State> ClockErrorBoundGenericBuilder<S>

Source

pub fn as_of_tsc( self, value: u64, ) -> ClockErrorBoundGenericBuilder<SetAsOfTsc<S>>
where S::AsOfTsc: IsUnset,

Optional (Some / Option setters). Default: 0.

Source

pub fn maybe_as_of_tsc( self, value: Option<u64>, ) -> ClockErrorBoundGenericBuilder<SetAsOfTsc<S>>
where S::AsOfTsc: IsUnset,

Optional (Some / Option setters). Default: 0.

Source

pub fn as_of(self, value: TimeSpec) -> ClockErrorBoundGenericBuilder<SetAsOf<S>>
where S::AsOf: IsUnset,

Optional (Some / Option setters). Default: TimeSpec::new(0, 0).

Source

pub fn maybe_as_of( self, value: Option<TimeSpec>, ) -> ClockErrorBoundGenericBuilder<SetAsOf<S>>
where S::AsOf: IsUnset,

Optional (Some / Option setters). Default: TimeSpec::new(0, 0).

Source

pub fn void_after( self, value: TimeSpec, ) -> ClockErrorBoundGenericBuilder<SetVoidAfter<S>>
where S::VoidAfter: IsUnset,

Optional (Some / Option setters). Default: TimeSpec::new(0, 0).

Source

pub fn maybe_void_after( self, value: Option<TimeSpec>, ) -> ClockErrorBoundGenericBuilder<SetVoidAfter<S>>
where S::VoidAfter: IsUnset,

Optional (Some / Option setters). Default: TimeSpec::new(0, 0).

Source

pub fn bound_nsec( self, value: i64, ) -> ClockErrorBoundGenericBuilder<SetBoundNsec<S>>
where S::BoundNsec: IsUnset,

Optional (Some / Option setters). Default: 0.

Source

pub fn maybe_bound_nsec( self, value: Option<i64>, ) -> ClockErrorBoundGenericBuilder<SetBoundNsec<S>>
where S::BoundNsec: IsUnset,

Optional (Some / Option setters). Default: 0.

Source

pub fn period(self, value: f64) -> ClockErrorBoundGenericBuilder<SetPeriod<S>>
where S::Period: IsUnset,

Optional (Some / Option setters). Default: 0.0.

V3 only: the period in seconds per tick.

Source

pub fn maybe_period( self, value: Option<f64>, ) -> ClockErrorBoundGenericBuilder<SetPeriod<S>>
where S::Period: IsUnset,

Optional (Some / Option setters). Default: 0.0.

V3 only: the period in seconds per tick.

Source

pub fn period_err( self, value: f64, ) -> ClockErrorBoundGenericBuilder<SetPeriodErr<S>>
where S::PeriodErr: IsUnset,

Optional (Some / Option setters). Default: 0.0.

V3 only: the relative error of the period, a dimensionless ratio in [0, 1).

Source

pub fn maybe_period_err( self, value: Option<f64>, ) -> ClockErrorBoundGenericBuilder<SetPeriodErr<S>>
where S::PeriodErr: IsUnset,

Optional (Some / Option setters). Default: 0.0.

V3 only: the relative error of the period, a dimensionless ratio in [0, 1).

Source

pub fn disruption_marker( self, value: u64, ) -> ClockErrorBoundGenericBuilder<SetDisruptionMarker<S>>
where S::DisruptionMarker: IsUnset,

Optional (Some / Option setters). Default: 0.

Source

pub fn maybe_disruption_marker( self, value: Option<u64>, ) -> ClockErrorBoundGenericBuilder<SetDisruptionMarker<S>>
where S::DisruptionMarker: IsUnset,

Optional (Some / Option setters). Default: 0.

Source

pub fn max_drift_ppb( self, value: u32, ) -> ClockErrorBoundGenericBuilder<SetMaxDriftPpb<S>>
where S::MaxDriftPpb: IsUnset,

Optional (Some / Option setters). Default: 0.

Source

pub fn maybe_max_drift_ppb( self, value: Option<u32>, ) -> ClockErrorBoundGenericBuilder<SetMaxDriftPpb<S>>
where S::MaxDriftPpb: IsUnset,

Optional (Some / Option setters). Default: 0.

Source

pub fn clock_status( self, value: ClockStatus, ) -> ClockErrorBoundGenericBuilder<SetClockStatus<S>>
where S::ClockStatus: IsUnset,

Optional (Some / Option setters). Default: ClockStatus::Unknown.

Source

pub fn maybe_clock_status( self, value: Option<ClockStatus>, ) -> ClockErrorBoundGenericBuilder<SetClockStatus<S>>
where S::ClockStatus: IsUnset,

Optional (Some / Option setters). Default: ClockStatus::Unknown.

Source

pub fn clock_disruption_support_enabled( self, value: bool, ) -> ClockErrorBoundGenericBuilder<SetClockDisruptionSupportEnabled<S>>
where S::ClockDisruptionSupportEnabled: IsUnset,

Optional (Some / Option setters). Default: false.

Source

pub fn maybe_clock_disruption_support_enabled( self, value: Option<bool>, ) -> ClockErrorBoundGenericBuilder<SetClockDisruptionSupportEnabled<S>>
where S::ClockDisruptionSupportEnabled: IsUnset,

Optional (Some / Option setters). Default: false.

Source§

impl<S: IsComplete> ClockErrorBoundGenericBuilder<S>

Source

pub fn build( self, layout_version: ClockErrorBoundLayoutVersion, ) -> ClockErrorBound

Custom build finishing function on the generated ClockErrorBoundLayoutBuilder.

Take the layout version number as a parameter, it is a u16 to ease casting of the earlier version of the SHMHeader.

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