Struct scrypto_test::prelude::UtcDateTime

pub struct UtcDateTime { /* private fields */ }

A UtcDateTime represents a Unix timestamp on the UTC Calendar.

It can represent any date between 1-1-1 00:00:00 and [u32::MAX]-12-31 23:59:59 (inclusive).

In terms of indexing:

• Months and days of month are 1-based (i.e. Dec 15th 2022 corresponds to 2022-12-15).
• Hour, minute and second are 0-based, based on the 24-hour clock. Midnight is represented as 00:00:00 and 23:59:59 is the last second before midnight. Following Unix timstamp conventions, leap seconds are not supported.

UtcDateTime supports methods for easy conversion to and from the Instant type, which can be queried from the Radix Engine.

Implementations

impl UtcDateTime

pub fn new( year: u32, month: u8, day_of_month: u8, hour: u8, minute: u8, second: u8 ) -> Result<UtcDateTime, DateTimeError>

Creates a UtcDateTime from its individual components.

Months and days of month are 1-based, with the following limits:

• Valid year range is: 1 to u32::MAXinclusive.
• Valid month values are: 1 to 12 inclusive.
• Valid day of month values are: 1 to {28, 29, 30, 31} inclusive. The upper limit depends on the month and year, as per the Gregorian calendar.

An attempt to create an invalid date (e.g. 2022-04-31 or 2023-02-29) will result in a corresponding Err(DateTimeError).

Hour, minute and second constitute a 0-based 24-hour clock. Midnight is represented as 00:00:00 and 23:59:59 is the maximum possible time (a second before midnight). Following Unix time conventions, leap seconds are not represented in this system.

pub fn from_instant(instant: &Instant) -> Result<UtcDateTime, DateTimeError>

Creates a UtcDateTime from an Instant.

The minimum supported seconds_since_unix_epoch value is -62135596800 (corresponding to 1-1-1 00:00:00) and the maximum value is 135536014634284799 (corresponding to [u32::Max]-12-31 23:59:59).

pub fn to_instant(&self) -> Instant

Creates an Instant from this UtcDateTime

pub fn year(&self) -> u32

pub fn month(&self) -> u8

pub fn day_of_month(&self) -> u8

pub fn hour(&self) -> u8

pub fn minute(&self) -> u8

pub fn second(&self) -> u8

pub fn add_days(&self, days_to_add: i64) -> Option<UtcDateTime>

pub fn add_hours(&self, hours_to_add: i64) -> Option<UtcDateTime>

pub fn add_minutes(&self, minutes_to_add: i64) -> Option<UtcDateTime>

pub fn add_seconds(&self, seconds_to_add: i64) -> Option<UtcDateTime>

Trait Implementations

impl<X> Categorize<X> for UtcDateTime

where X: CustomValueKind,

fn value_kind() -> ValueKind<X>

impl Clone for UtcDateTime

fn clone(&self) -> UtcDateTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UtcDateTime

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

Formats the value using the given formatter.

impl<D, X> Decode<X, D> for UtcDateTime

where D: Decoder<X>, X: CustomValueKind,

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<X> ) -> Result<UtcDateTime, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl Describe<NoCustomTypeKind> for UtcDateTime

const TYPE_ID: RustTypeId = _

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<NoCustomTypeKind, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<NoCustomTypeKind>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl Describe<ScryptoCustomTypeKind> for UtcDateTime

const TYPE_ID: RustTypeId = _

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<ScryptoCustomTypeKind, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<C>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl Display for UtcDateTime

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

Formats the value using the given formatter.

impl<E, X> Encode<X, E> for UtcDateTime

where E: Encoder<X>, X: CustomValueKind,

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl From<UtcDateTime> for Instant

fn from(dt: UtcDateTime) -> Instant

Converts to this type from the input type.

impl FromStr for UtcDateTime

type Err = ParseUtcDateTimeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<UtcDateTime, <UtcDateTime as FromStr>::Err>

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

impl Hash for UtcDateTime

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Ord for UtcDateTime

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

Restrict a value to a certain interval.

impl PartialEq for UtcDateTime

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for UtcDateTime

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

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

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

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

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

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

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

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

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

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

impl<X> SborTuple<X> for UtcDateTime

where X: CustomValueKind,

fn get_length(&self) -> usize

impl TryFrom<Instant> for UtcDateTime

type Error = DateTimeError

The type returned in the event of a conversion error.

fn try_from( instant: Instant ) -> Result<UtcDateTime, <UtcDateTime as TryFrom<Instant>>::Error>

Performs the conversion.

impl Copy for UtcDateTime

impl Eq for UtcDateTime

impl StructuralPartialEq for UtcDateTime