Struct PositiveDuration 

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

A Duration guaranteed to be strictly positive (non-zero).

Useful for timeouts and intervals where a zero duration is meaningless: the type turns “must be greater than zero” into a guarantee carried by the value instead of a check repeated at every call site.

Implementations

impl PositiveDuration

pub fn new(value: Duration) -> PrimitiveResult<Self>

Creates a PositiveDuration. Returns Invalid if value is Duration::ZERO.

pub fn get(self) -> Duration

Returns the wrapped Duration.

Trait Implementations

impl AsRef<Duration> for PositiveDuration

fn as_ref(&self) -> &Duration

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PositiveDuration

fn clone(&self) -> PositiveDuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PositiveDuration

impl Debug for PositiveDuration

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

Formats the value using the given formatter.

impl Display for PositiveDuration

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

Formats the value using the given formatter.

impl Eq for PositiveDuration

impl Hash for PositiveDuration

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 Ord for PositiveDuration

fn cmp(&self, other: &PositiveDuration) -> 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 PositiveDuration

fn eq(&self, other: &PositiveDuration) -> 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 PositiveDuration

fn partial_cmp(&self, other: &PositiveDuration) -> 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 StructuralPartialEq for PositiveDuration

impl TryFrom<Duration> for PositiveDuration

type Error = PrimitiveError

The type returned in the event of a conversion error.

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

Performs the conversion.