Struct BoundedSecs 

pub struct BoundedSecs<const MIN: u64, const MAX: u64>(/* private fields */);

A whole number of seconds in MIN..=MAX, with MIN >= 1.

Deserializes from a TOML integer and rejects out-of-range values at load time, so an embedder cannot build an out-of-range value either.

Examples

use std::time::Duration;
use mcpls_core::config::TimeoutSecs;

assert!(TimeoutSecs::new(0).is_err());
assert!(TimeoutSecs::new(901).is_err());
assert_eq!(TimeoutSecs::new(45).unwrap().as_duration(), Duration::from_secs(45));

Implementations

impl<const MIN: u64, const MAX: u64> BoundedSecs<MIN, MAX>

pub const fn new(secs: u64) -> Result<Self, InvalidSecs>

Builds the value from secs.

Errors

InvalidSecs when secs is outside MIN..=MAX.

pub const fn get(self) -> u64

The wrapped number of seconds, within MIN..=MAX.

pub const fn as_duration(self) -> Duration

The wrapped number of seconds as a Duration.

impl BoundedSecs<1, MAX_TIMEOUT_SECONDS>

pub const DEFAULT: Self

Thirty seconds.

impl BoundedSecs<{ PROGRESS_SETTLE.as_secs() + 1 }, { INDEXING_STALENESS_BOUND.as_secs() - 1 }>

pub const DEFAULT: Self

The built-in default, DEFAULT_INDEXING_READY_TIMEOUT_SECS.

Trait Implementations

impl<const MIN: u64, const MAX: u64> Clone for BoundedSecs<MIN, MAX>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MIN: u64, const MAX: u64> Copy for BoundedSecs<MIN, MAX>

impl<const MIN: u64, const MAX: u64> Debug for BoundedSecs<MIN, MAX>

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

Formats the value using the given formatter.

impl<'de, const MIN: u64, const MAX: u64> Deserialize<'de> for BoundedSecs<MIN, MAX>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const MIN: u64, const MAX: u64> Eq for BoundedSecs<MIN, MAX>

impl<const MIN: u64, const MAX: u64> From<BoundedSecs<MIN, MAX>> for u64

fn from(value: BoundedSecs<MIN, MAX>) -> Self

Converts to this type from the input type.

impl<const MIN: u64, const MAX: u64> Hash for BoundedSecs<MIN, MAX>

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<const MIN: u64, const MAX: u64> PartialEq for BoundedSecs<MIN, MAX>

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

Equality operator ==.

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

Inequality operator !=.

impl<const MIN: u64, const MAX: u64> Serialize for BoundedSecs<MIN, MAX>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const MIN: u64, const MAX: u64> StructuralPartialEq for BoundedSecs<MIN, MAX>

impl<const MIN: u64, const MAX: u64> TryFrom<u64> for BoundedSecs<MIN, MAX>

type Error = InvalidSecs

The type returned in the event of a conversion error.

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

Performs the conversion.