Struct itron_solid_fmp3::time::Timeout

#[repr(transparent)]
pub struct Timeout { /* fields omitted */ }

This is supported on crate feature unstable only.

A valid timeout value (abi::TMO).

In addition to finite durations, this type can represent the following special values: ZERO indicating zero or polling and FOREVER representing an infinite duration. TMO_NBLK is not a valid value for this type.

timeout! can be used to construct a Timeout in a concise syntax.

Implementations

impl Timeout

pub const ZERO: Self

The zero timeout value, which causes polling.

pub const FOREVER: Self

The infinite timeout value.

pub const unsafe fn from_raw(value: TMO) -> Self

Construct a new Timeout from a raw value.

Safety

value must be a valid timeout value. This crate treats E_PAR caused by invalid timeout values as a critical error.

pub const fn as_raw(self) -> TMO

pub const fn is_finite(self) -> bool

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

Construct a new Timeout from the specified number of seconds.

Returns None if the specified duration is not representable.

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

Construct a new Timeout from the specified number of milliseconds.

Returns None if the specified duration is not representable.

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

Construct a new Timeout from the specified number of microseconds.

Returns None if the specified duration is not representable.

pub fn from_nanos(nanos: u128) -> Option<Self>

Construct a new Timeout from the specified number of nanoseconds.

Returns None if the specified duration is not representable.

Trait Implementations

impl Clone for Timeout

fn clone(&self) -> Timeout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timeout

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

Formats the value using the given formatter.

impl Hash for Timeout

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Timeout

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Timeout> for Timeout

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

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

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

This method tests for !=.

impl PartialOrd<Timeout> for Timeout

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<Duration> for Timeout

type Error = TryFromDurationError

The type returned in the event of a conversion error.

fn try_from(d: StdDuration) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Duration> for Timeout

type Error = TryFromDurationError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Timeout> for Duration

type Error = TryFromDurationError

The type returned in the event of a conversion error.

fn try_from(d: Timeout) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Timeout

impl Eq for Timeout

impl StructuralEq for Timeout

impl StructuralPartialEq for Timeout