Struct UpDuration 

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

A duration from the Flockfile grammar ^\d+(ms|h|m|s)?$

Plain digits are milliseconds; ms/s/m/h are milliseconds/seconds/minutes/hours. Used for min_uptime, kill_timeout, and the other lifecycle timers.

ms is checked before the single-letter suffixes, so m still means minutes and only a trailing ms means milliseconds: 5m and 5ms differ by a factor of sixty thousand.

Example

use shep_core::values::UpDuration;

assert_eq!("30s".parse::<UpDuration>()?.as_millis(), 30_000);
assert_eq!("500ms".parse::<UpDuration>()?.as_millis(), 500);
assert_eq!("5m".parse::<UpDuration>()?.as_millis(), 300_000);
assert!("30S".parse::<UpDuration>().is_err()); // lowercase units only

Implementations

impl UpDuration

pub const fn from_millis(ms: u64) -> Self

Wraps a raw millisecond count

pub const fn as_duration(self) -> Duration

Returns the wrapped core::time::Duration

pub const fn as_millis(self) -> u64

Returns the duration in whole milliseconds

Trait Implementations

impl Clone for UpDuration

fn clone(&self) -> UpDuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for UpDuration

impl Debug for UpDuration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UpDuration

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

Deserialize this value from the given Serde deserializer.

impl Display for UpDuration

Formats with the largest unit dividing the value exactly (ms as digits)

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

Formats the value using the given formatter.

impl Eq for UpDuration

impl FromStr for UpDuration

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses ^\d+(ms|h|m|s)?$: plain digits are milliseconds

ms is matched before the single-letter suffixes below, so a trailing m alone still means minutes.

Errors

• ParseUpDurationError::Empty: empty input.
• ParseUpDurationError::MissingDigits: unit with no digits.
• ParseUpDurationError::InvalidCharacter: anything outside ASCII digits plus one trailing lowercase h/m/s/ms.
• ParseUpDurationError::Overflow: milliseconds overflow u64.

type Err = ParseUpDurationError

The associated error which can be returned from parsing.

impl Hash for UpDuration

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 UpDuration

Available on crate feature schema only.

String-shaped, matching this type’s Serialize/Deserialize: see MemSize’s own JsonSchema impl for the full reasoning, which applies here unchanged.

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

The name of the generated JSON Schema.

fn json_schema(_: &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.

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

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

impl Ord for UpDuration

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for UpDuration

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for UpDuration

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

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UpDuration