Struct NonZeroDuration

pub struct NonZeroDuration(/* private fields */);

A thin wrapper over a Duration that guarantees that the underlying Duration is non-zero.

Implementations

impl NonZeroDuration

pub const unsafe fn new_unchecked(d: Duration) -> NonZeroDuration

Creates a non-zero without checking the value.

Safety

If d is zero, unsafe code which relies on the invariant that NonZeroDuration values are always zero may cause undefined behavior.

pub const fn from_secs(secs: u64) -> Option<NonZeroDuration>

Creates a new NonZeroDuration from the specified number of whole seconds if that number is non-zero.

pub const fn from_nonzero_secs(secs: NonZeroU64) -> NonZeroDuration

Creates a new NonZeroDuration from the specified non-zero number of whole seconds.

pub const fn from_secs_nanos(secs: u64, nanos: u32) -> Option<NonZeroDuration>

Creates a new NonZeroDuration from the specified number of whole seconds and additional nanoseconds if the resulting duration is non-zero.

If the number of nanoseconds is greater than 1 billion (the number of nanoseconds in a second), then it will carry over into the seconds provided.

Panics

This constructor will panic if the carry from the nanoseconds overflows the seconds counter.

pub const fn from_nonzero_secs_nanos( secs: NonZeroU64, nanos: NonZeroU32, ) -> NonZeroDuration

Creates a new NonZeroDuration from the specified non-zero number of whole seconds and additional nanoseconds.

If the number of nanoseconds is greater than 1 billion (the number of nanoseconds in a second), then it will carry over into the seconds provided.

Panics

This constructor will panic if the carry from the nanoseconds overflows the seconds counter.

pub const fn from_millis(millis: u64) -> Option<NonZeroDuration>

Creates a new NonZeroDuration from the specified number of milliseconds if that number is non-zero.

pub const fn from_nonzero_millis(millis: NonZeroU64) -> NonZeroDuration

Creates a new NonZeroDuration from the specified non-zero number of milliseconds.

pub const fn from_micros(micros: u64) -> Option<NonZeroDuration>

Creates a new NonZeroDuration from the specified number of microseconds if that number is non-zero.

pub const fn from_nonzero_micros(micros: NonZeroU64) -> NonZeroDuration

Creates a new NonZeroDuration from the specified non-zero number of microseconds.

pub const fn from_nanos(nanos: u64) -> Option<NonZeroDuration>

Creates a new NonZeroDuration from the specified number of nanoseconds if that number is non-zero.

pub const fn from_nonzero_nanos(nanos: NonZeroU64) -> NonZeroDuration

Creates a new NonZeroDuration from the specified non-zero number of nanoseconds.

pub const fn new(d: Duration) -> Option<NonZeroDuration>

Creates a non-zero if the given value is not zero.

pub fn saturating_add(self, d: Duration) -> Self

Like Duration::saturating_add.

pub fn saturating_mul(self, m: NonZeroU32) -> Self

Like Duration::saturating_mul.

pub const fn get(self) -> Duration

Returns the value as a Duration.

Trait Implementations

impl Add<Duration> for NonZeroDuration

type Output = NonZeroDuration

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Self::Output

Performs the + operation.

impl Add for NonZeroDuration

type Output = NonZeroDuration

The resulting type after applying the + operator.

fn add(self, rhs: NonZeroDuration) -> Self::Output

Performs the + operation.

impl Clone for NonZeroDuration

fn clone(&self) -> NonZeroDuration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NonZeroDuration

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

Formats the value using the given formatter.

impl From<NonZeroDuration> for Duration

fn from(NonZeroDuration: NonZeroDuration) -> Duration

Converts to this type from the input type.

impl Hash for NonZeroDuration

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<NonZero<u32>> for NonZeroDuration

type Output = NonZeroDuration

The resulting type after applying the * operator.

fn mul(self, rhs: NonZeroU32) -> Self::Output

Performs the * operation.

impl Ord for NonZeroDuration

fn cmp(&self, other: &NonZeroDuration) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for NonZeroDuration

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for NonZeroDuration

fn partial_cmp(&self, other: &NonZeroDuration) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for NonZeroDuration

impl Eq for NonZeroDuration

impl StructuralPartialEq for NonZeroDuration