Struct DateTime 

pub struct DateTime { /* private fields */ }

An OCPI timestamp: an instant in UTC, serialised as RFC 3339 with a Z designator.

All timestamps are formatted as string(25) following RFC 3339, with some additional limitations. All timestamps SHALL be in UTC. The absence of the timezone designator implies a UTC timestamp. Fractional seconds MAY be used.

The six forms the spec lists as the only allowed ones are, by example:

2015-06-29T20:39:09Z        2015-06-29T20:39:09
2016-12-29T17:45:09.2Z      2016-12-29T17:45:09.2
2018-01-01T01:08:01.123Z    2018-01-01T01:08:01.123

+00:00 is not Z

The spec is explicit: “NOTE: +00:00 is not the same as UTC.” A DateTime parsed from a timestamp carrying an explicit offset — even +00:00 — is converted to the correct UTC instant so no data is lost, but is flagged: DateTime::is_canonical returns false and Validate::validate reports it. Serialising always emits the canonical Z form, so a value that passes through this crate comes out conformant.

Fractional seconds are preserved

A timestamp read as …09.2Z is written back as …09.2Z, not …09.200Z. The number of fractional digits is formatting metadata: it takes no part in PartialEq, Ord or std::hash::Hash, which compare the instant alone.

use ocpi_kit::types::DateTime;

let t: DateTime = "2016-12-29T17:45:09.2Z".parse().unwrap();
assert_eq!(t.to_string(), "2016-12-29T17:45:09.2Z");
assert_eq!(t, "2016-12-29T17:45:09.200Z".parse::<DateTime>().unwrap());

Spec: 2.3.0 §types_datetime_type

Implementations

impl DateTime

pub fn now() -> Self

The current time, with second precision.

pub fn local_parts(self, offset_seconds: i32) -> LocalParts

The wall clock this instant shows in a zone offset_seconds east of UTC.

Every time-of-day and day-of-week rule in OCPI is written in a Location’s local time — tariff restrictions, opening hours — so reading one means converting first. The result is in this crate’s own LocalParts, so no date-time library reaches the API.

The offset has to come from somewhere: a Location carries an IANA time_zone, and TimeZone resolves it against the zone database, which is what a rule spanning a daylight-saving change needs.

use ocpi_kit::types::DateTime;

let instant: DateTime = "2024-01-15T23:30:00Z".parse()?;
let local = instant.local_parts(3600); // CET, UTC+1
assert_eq!(local.time.hour(), 0);
assert_eq!(local.date.day(), 16);
assert_eq!(local.iso_weekday, 2); // Tuesday

pub const fn unix_timestamp(self) -> i64

Seconds since the Unix epoch.

pub fn from_unix_timestamp(secs: i64) -> Result<Self, InvalidDateTime>

Builds a timestamp from seconds since the Unix epoch.

Errors

Returns InvalidDateTime if the value is outside the supported range.

pub const fn is_canonical(self) -> bool

Whether the value was written in one of the six forms the spec allows.

false means the source used an explicit UTC offset (including +00:00), a lower-case z, or a space instead of T. The instant itself is still correct.

pub const fn with_fractional_digits(self, digits: u8) -> Self

Returns a copy that will be written with exactly digits fractional-second digits.

digits is clamped to 9.

pub const fn fractional_digits(self) -> u8

How many fractional-second digits this value will be written with.

pub fn parse(text: &str) -> Result<Self, InvalidDateTime>

Parses one of the RFC 3339 forms OCPI allows, plus the tolerated deviations described on the type.

Errors

Returns InvalidDateTime when the text is not a date-time at all, or carries an offset that would place it outside the representable range.

Trait Implementations

impl Clone for DateTime

fn clone(&self) -> DateTime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DateTime

impl Debug for DateTime

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DateTime

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

Deserialize this value from the given Serde deserializer.

impl Display for DateTime

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

Formats the value using the given formatter.

impl Eq for DateTime

impl From<DateTime> for OffsetDateTime

fn from(value: DateTime) -> Self

Converts to this type from the input type.

impl From<OffsetDateTime> for DateTime

fn from(value: OffsetDateTime) -> Self

Converts to this type from the input type.

impl FromStr for DateTime

type Err = InvalidDateTime

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 DateTime

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 DateTime

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 DateTime

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DateTime

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

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

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for DateTime

type Error = InvalidDateTime

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Validate for DateTime

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.