Struct LocalTime 

pub struct LocalTime { /* private fields */ }

A wall-clock time of day, HH:MM in 24-hour form with leading zeros.

Must be in 24h format with leading zeros. Example: “18:15”. Hour/Minute separator: “:” Regex: ([0-1][0-9]|2[0-3]):[0-5][0-9]

Spec: 2.3.0 §mod_locations_regularhours_class, §mod_tariffs_tariffrestrictions_class

Implementations

impl LocalTime

pub const MIDNIGHT: Self

Midnight, which the spec also uses to mean “end of day” in TariffRestrictions.end_time.

pub fn new(hour: u8, minute: u8) -> Result<Self, InvalidLocalTime>

Creates a time of day.

Errors

Returns InvalidLocalTime unless hour is 0–23 and minute is 0–59.

pub const fn hour(self) -> u8

The hour, 0–23.

pub const fn minute(self) -> u8

The minute, 0–59.

pub const fn minutes_since_midnight(self) -> u16

Minutes since midnight, for comparing and for interval arithmetic.

pub const fn is_within(self, start: Self, end: Self) -> bool

Whether self falls in the half-open interval [start, end), wrapping past midnight.

If end_time < start_time then the period wraps around to the next day. To stop at end of the day use: 00:00.

start == end is the whole day

The specification does not say what start_time == end_time means, and the two readings are not close: taken as an empty interval the restriction never matches, taken as a wrap-around it always does. This crate reads it as the whole day, for two reasons.

It is what the wrap-around rule already produces without a special case — the interval runs from start, past midnight, all the way back round to start — and it is the reading that fails safe. A TariffElement restricted to 00:00–00:00 that never matches leaves its dimension with no Price Component, and the specification’s answer to that is that the dimension is free; a tariff writer who meant “all day” would have silently given the energy away. The other direction merely charges what the tariff says.

Spec: 2.3.0 §mod_tariffs_tariffrestrictions_class

Trait Implementations

impl Clone for LocalTime

fn clone(&self) -> LocalTime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LocalTime

impl Debug for LocalTime

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

Formats the value using the given formatter.

impl Default for LocalTime

fn default() -> LocalTime

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LocalTime

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

Deserialize this value from the given Serde deserializer.

impl Display for LocalTime

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

Formats the value using the given formatter.

impl Eq for LocalTime

impl FromStr for LocalTime

type Err = InvalidLocalTime

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for LocalTime

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 LocalTime

Available on crate feature schema only.

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

The name of the generated JSON Schema.

fn json_schema(_g: &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 LocalTime

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for LocalTime

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

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LocalTime

impl Validate for LocalTime

fn validate_in(&self, _v: &mut Validator)

Appends this value’s violations to v, relative to v’s current position.

fn validate(&self) -> Result<(), Violations>

Validates this value as the root of an object graph.