Struct IdleTimeout

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

Maximum duration of inactivity to accept before timing out the connection.

This wraps an underlying VarInt, representing the duration in milliseconds. Values can be constructed by converting directly from VarInt, or using TryFrom<Duration>.

// A `VarInt`-encoded value in milliseconds
let timeout = IdleTimeout::from(VarInt::from_u32(10_000));

// Try to convert a `Duration` into a `VarInt`-encoded timeout
let timeout = IdleTimeout::try_from(Duration::from_secs(10))?;

Trait Implementations

impl Clone for IdleTimeout

fn clone(&self) -> IdleTimeout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdleTimeout

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

Formats the value using the given formatter.

impl Default for IdleTimeout

fn default() -> IdleTimeout

Returns the “default value” for a type.

impl From<VarInt> for IdleTimeout

fn from(inner: VarInt) -> Self

Converts to this type from the input type.

impl Hash for IdleTimeout

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 IdleTimeout

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

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

fn partial_cmp(&self, other: &IdleTimeout) -> 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 TryFrom<Duration> for IdleTimeout

type Error = VarIntBoundsExceeded

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for IdleTimeout

impl Eq for IdleTimeout

impl StructuralPartialEq for IdleTimeout