Enum smart_config::metadata::TimeUnit

#[non_exhaustive]
pub enum TimeUnit {
    Millis,
    Seconds,
    Minutes,
    Hours,
    Days,
    Weeks,
}

Unit of time measurement.

Examples

You can use multiplication to define durations (e.g., for parameter values):

let dur = 5 * TimeUnit::Hours;
assert_eq!(dur, Duration::from_secs(5 * 3_600));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Millis

Millisecond (0.001 seconds).

Seconds

Base unit – second.

Minutes

Minute (60 seconds).

Hours

Hour (3,600 seconds).

Days

Day (86,400 seconds).

Weeks

Week (7 days).

Implementations

impl TimeUnit

pub fn checked_mul(self, factor: u64) -> Option<Duration>

Multiplies this time unit by the specified factor.

Trait Implementations

impl Clone for TimeUnit

fn clone(&self) -> TimeUnit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeUnit

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

Formats the value using the given formatter.

impl DeserializeParam<Duration> for TimeUnit

Supports deserializing a Duration from a number, with self being the unit of measurement.

Examples

use smart_config::testing;

#[derive(DescribeConfig, DeserializeConfig)]
struct TestConfig {
    #[config(with = TimeUnit::Millis)]
    time_ms: Duration,
}

let source = smart_config::config!("time_ms": 100);
let config = testing::test::<TestConfig>(source)?;
assert_eq!(config.time_ms, Duration::from_millis(100));

const EXPECTING: BasicTypes = BasicTypes::INTEGER

Describes which parameter this deserializer is expecting.

fn describe(&self, description: &mut TypeDescription)

Additional info about the deserialized type, e.g., extended description.

fn deserialize_param( &self, ctx: DeserializeContext<'_>, param: &'static ParamMetadata, ) -> Result<Duration, ErrorWithOrigin>

Performs deserialization given the context and param metadata.

fn serialize_param(&self, param: &Duration) -> Value

Serializes the provided parameter to the JSON model.

impl Display for TimeUnit

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

Formats the value using the given formatter.

impl From<TimeUnit> for Duration

fn from(unit: TimeUnit) -> Self

Converts to this type from the input type.

impl From<TimeUnit> for UnitOfMeasurement

fn from(unit: TimeUnit) -> Self

Converts to this type from the input type.

impl Hash for TimeUnit

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 Mul<TimeUnit> for u64

Panics on overflow.

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, rhs: TimeUnit) -> Self::Output

Performs the * operation.

impl Mul<u64> for TimeUnit

Panics on overflow.

type Output = Duration

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Self::Output

Performs the * operation.

impl PartialEq for TimeUnit

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

impl Eq for TimeUnit

impl StructuralPartialEq for TimeUnit