Struct spin_sleep::LoopHelperBuilder

pub struct LoopHelperBuilder { /* private fields */ }

Builds LoopHelper.

Implementations

impl LoopHelperBuilder

pub fn report_interval_s(self, seconds: Seconds) -> Self

Sets the interval between LoopHelper::report_rate reports in seconds.

pub fn report_interval(self, duration: Duration) -> Self

Sets the interval between LoopHelper::report_rate reports.

pub fn native_accuracy_ns(self, accuracy: SubsecondNanoseconds) -> Self

Sets the native sleep accuracy. See SpinSleeper::new for details.

Defaults to a platform specific opinionated value, that can change from release to release. Set this to ensure consistent behaviour across releases. However, consider that this value should be tuned & tested for a given platform.

pub fn build_without_target_rate(self) -> LoopHelper

Builds a LoopHelper without targeting a rate. This means all calls to LoopHelper::loop_sleep will simply return immediately. Normally used when only interested in the LoopHelper rate reporting.

pub fn build_with_target_rate<R: Into<RatePerSecond>>( self, target_rate: R ) -> LoopHelper

Builds a LoopHelper targeting an input target_rate. Note: The target_rate only affects LoopHelper::loop_sleep.

Trait Implementations

impl Clone for LoopHelperBuilder

fn clone(&self) -> LoopHelperBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LoopHelperBuilder

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

Formats the value using the given formatter.

impl PartialEq<LoopHelperBuilder> for LoopHelperBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for LoopHelperBuilder

impl Eq for LoopHelperBuilder

impl StructuralEq for LoopHelperBuilder

impl StructuralPartialEq for LoopHelperBuilder