Struct holochain_core_types::time::Iso8601

pub struct Iso8601(_);

This struct represents datetime data recovered from a string in the ISO 8601 and RFC 3339 (more restrictive) format. Invalid try_from conversions fails w/ Result<DateTime, HolochainError>.

Iso8601 wraps a DateTime, and its Display/Debug formats default to the ISO 8601 / RFC 3339 format, respectively:

Display: 2018-10-11T03:23:38+00:00 Debug: Iso8601(2018-10-11T03:23:38+00:00)

More info on the relevant wikipedia article.

Methods

impl Iso8601

Infallible conversions into and from an Iso8601. The only infallible ways to create an Iso8601 is from a Unix timestamp, or new with a timestamp and nanoseconds, or by converting to/from its underlying DateTime.

pub fn new(secs: i64, nsecs: u32) -> Self

Trait Implementations

impl<'a> From<&'a Iso8601> for JsonString

fn from(v: &Iso8601) -> JsonString

Performs the conversion.

impl From<Iso8601> for JsonString

fn from(v: Iso8601) -> JsonString

Performs the conversion.

impl From<i64> for Iso8601

fn from(secs: i64) -> Self

Performs the conversion.

impl From<u64> for Iso8601

fn from(secs: u64) -> Self

Performs the conversion.

impl From<i32> for Iso8601

fn from(secs: i32) -> Self

Performs the conversion.

impl From<u32> for Iso8601

fn from(secs: u32) -> Self

Performs the conversion.

impl From<Iso8601> for DateTime<FixedOffset>

fn from(lhs: Iso8601) -> DateTime<FixedOffset>

Performs the conversion.

impl<'_> From<&'_ Iso8601> for DateTime<FixedOffset>

fn from(lhs: &Iso8601) -> DateTime<FixedOffset>

Performs the conversion.

impl From<DateTime<FixedOffset>> for Iso8601

fn from(lhs: DateTime<FixedOffset>) -> Iso8601

Performs the conversion.

impl<'_> From<&'_ DateTime<FixedOffset>> for Iso8601

fn from(lhs: &DateTime<FixedOffset>) -> Iso8601

Performs the conversion.

impl Clone for Iso8601

fn clone(&self) -> Iso8601

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Iso8601

impl Ord for Iso8601

fn cmp(&self, other: &Iso8601) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Iso8601> for Iso8601

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Iso8601> for Iso8601

fn partial_cmp(&self, other: &Iso8601) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Iso8601) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Iso8601) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Iso8601) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Iso8601) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Display for Iso8601

Outputs the canonicalized ISO 8601 / RFC 3339 form for a valid timestamp.

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

Formats the value using the given formatter.

impl Debug for Iso8601

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

Formats the value using the given formatter.

impl<D: Into<Duration>> Sub<D> for Iso8601

type Output = Result<Iso8601, HolochainError>

The resulting type after applying the - operator.

fn sub(self, rhs: D) -> Self::Output

Performs the - operation.

impl<'_, D: Into<Duration>> Sub<D> for &'_ Iso8601

type Output = Result<Iso8601, HolochainError>

The resulting type after applying the - operator.

fn sub(self, rhs: D) -> Self::Output

Performs the - operation.

impl<'a> TryFrom<&'a JsonString> for Iso8601

type Error = JsonError

The type returned in the event of a conversion error.

fn try_from(json_string: &JsonString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<JsonString> for Iso8601

type Error = JsonError

The type returned in the event of a conversion error.

fn try_from(json_string: JsonString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Iso8601

Conversions try_from on String/&str on an Iso8601 are fallible conversions, which may produce a HolochainError if the timestamp is not valid ISO 8601 / RFC 3339. We will allow some flexibilty; strip surrounding whitespace, a bare timestamp missing any timezone specifier will be assumed to be UTC "Zulu", make internal separators optional if unambiguous. If you keep to straight RFC 3339 timestamps, then parsing will be quick, otherwise we'll employ a regular expression to parse a more flexible subset of the ISO 8601 standard from your supplied timestamp, and then use the RFC 3339 parser again. We only do this validation once; at the creation of an Iso8601 from a String/&str. There are some years that can be encoded as a DateTime but not parsed, such as negative (BC/BCE) years.

type Error = HolochainError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'_> TryFrom<&'_ str> for Iso8601

type Error = HolochainError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl FromStr for Iso8601

type Err = HolochainError

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<D: Into<Duration>> Add<D> for Iso8601

Iso8601 +- Into: Add anything that can be converted into a std::time::Duration; for example, a Timeout or a Period. On Err, always represents the std::time::Duration as a Period for ease of interpretation.

type Output = Result<Iso8601, HolochainError>

The resulting type after applying the + operator.

fn add(self, rhs: D) -> Self::Output

Performs the + operation.

impl<'_, D: Into<Duration>> Add<D> for &'_ Iso8601

type Output = Result<Iso8601, HolochainError>

The resulting type after applying the + operator.

fn add(self, rhs: D) -> Self::Output

Performs the + operation.

impl StructuralPartialEq for Iso8601

impl StructuralEq for Iso8601

impl Serialize for Iso8601

Serialization w/ serde_json to/from String. This means that a timestamp will be deserialized to an Iso8601 and validated, which may fail, returning a serde::de::Error. Upon serialization, the canonicalized ISO 8601 / RFC 3339 version of the timestamp will be used.

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

Serialize this value into the given Serde serializer.

impl<'d> Deserialize<'d> for Iso8601

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

Deserialize this value from the given Serde deserializer.