Enum spirit_tokio::net::MaybeDuration

pub enum MaybeDuration {
    Unset,
    Off,
    Duration(Duration),
}

Configuration that can be unset, explicitly turned off or set to a duration.

Some network configuration options can be either turned off or set to a certain duration. We add the ability to leave them on the OS default (which is done if the field is not present in the configuration).

Panics

If using on your own and using Serialize, make sure that you use #[serde(skip_serializing_if = "MaybeDuration::is_unset")], or you'll get a panic during serialization.

Variants

Unset

Leaves the option at the OS default.

Signified by not being present in the configuration.

Off

Turns the option off.

Deserialized from false.

Duration(Duration)

Turns the option on with given duration.

Deserialized from human-readable duration specification, eg. 100ms or 30s.

Trait Implementations

impl Clone for MaybeDuration

fn clone(&self) -> MaybeDuration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MaybeDuration

impl Debug for MaybeDuration

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

Formats the value using the given formatter.

impl Default for MaybeDuration

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for MaybeDuration

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Eq for MaybeDuration

impl Hash for MaybeDuration

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 MaybeDuration

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<MaybeDuration> for MaybeDuration

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

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

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

This method tests for !=.

impl PartialOrd<MaybeDuration> for MaybeDuration

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

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

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

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

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

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

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

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

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

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

impl Serialize for MaybeDuration

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralEq for MaybeDuration

impl StructuralPartialEq for MaybeDuration