Struct Timeout 

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

Timeout value in milliseconds.

use solti_model::Timeout;

let timeout = Timeout::new(5_000).unwrap();
assert_eq!(timeout.as_millis(), 5_000);

let timeout = Timeout::new(10_000).unwrap();
assert_eq!(format!("{timeout}"), "10000ms");

Implementations

impl Timeout

pub fn new(ms: u64) -> ModelResult<Self>

Creates a timeout value.

Errors

Returns ModelError::Invalid when ms is zero.

Example

use solti_model::Timeout;

let timeout = Timeout::new(5_000).unwrap();
assert_eq!(timeout.as_millis(), 5_000);

pub const fn as_millis(&self) -> u64

Returns the timeout in milliseconds.

Example

use solti_model::Timeout;

let timeout = Timeout::new(10_000).unwrap();
assert_eq!(timeout.as_millis(), 10_000);

Trait Implementations

impl Clone for Timeout

fn clone(&self) -> Timeout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Timeout

impl Debug for Timeout

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Timeout

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Timeout

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

Formats the value using the given formatter.

impl Eq for Timeout

impl From<Timeout> for u64

fn from(t: Timeout) -> Self

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for Timeout

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

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

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 Timeout

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd 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

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 Serialize for Timeout

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Timeout

impl TryFrom<u64> for Timeout

type Error = ModelError

The type returned in the event of a conversion error.

fn try_from(ms: u64) -> Result<Self, Self::Error>

Performs the conversion.