Struct ibc_primitives::Timestamp

pub struct Timestamp { /* private fields */ }

A new type wrapper over Option<Time> to keep track of IBC packet timeout.

We use an explicit Option type to distinguish this when converting between a u64 value and a raw timestamp. In protocol buffer, the timestamp is represented as a u64 Unix timestamp in nanoseconds, with 0 representing the absence of timestamp.

Implementations

impl Timestamp

pub fn from_nanoseconds(nanoseconds: u64) -> Result<Self, ParseTimestampError>

The IBC protocol represents timestamps as u64 Unix timestamps in nanoseconds.

A protocol value of 0 indicates that the timestamp is not set. In this case, our domain type takes the value of None.

pub fn now() -> Self

Returns a Timestamp representation of the current time.

pub fn none() -> Self

Returns a Timestamp representation of a timestamp not being set.

pub fn duration_since(&self, other: &Self) -> Option<Duration>

Computes the duration difference of another Timestamp from the current one. Returns the difference in time as an core::time::Duration. Returns None if the other Timestamp is more advanced than the current or if either of the Timestamps is not set.

pub fn as_nanoseconds(&self) -> u64

👎Deprecated since 0.9.1: use nanoseconds instead

Convert a Timestamp to u64 value in nanoseconds. If no timestamp is set, the result is 0.

pub fn nanoseconds(self) -> u64

Convert a Timestamp to u64 value in nanoseconds. If no timestamp is set, the result is 0.

use ibc_primitives::Timestamp;

let max = u64::MAX;
let tx = Timestamp::from_nanoseconds(max).unwrap();
let utx = tx.nanoseconds();
assert_eq!(utx, max);
let min = u64::MIN;
let ti = Timestamp::from_nanoseconds(min).unwrap();
let uti = ti.nanoseconds();
assert_eq!(uti, min);
let tz = Timestamp::none();
let utz = tz.nanoseconds();
assert_eq!(utz, 0);

pub fn into_datetime(self) -> Option<OffsetDateTime>

Convert a Timestamp to an optional OffsetDateTime

pub fn into_tm_time(self) -> Option<Time>

Convert a Timestamp to an optional tendermint::Time

pub fn check_expiry(&self, other: &Self) -> Expiry

Checks whether the timestamp has expired when compared to the other timestamp. Returns an Expiry result.

pub fn is_set(&self) -> bool

Checks whether the timestamp is set.

Trait Implementations

impl Add<Duration> for Timestamp

type Output = Result<Timestamp, TimestampOverflowError>

The resulting type after applying the + operator.

fn add(self, duration: Duration) -> Result<Self, TimestampOverflowError>

Performs the + operation.

impl BorshDeserialize for Timestamp

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for Timestamp

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

fn try_to_vec(&self) -> Result<Vec<u8>, Error>

Serialize this instance into a vector of bytes.

impl Clone for Timestamp

fn clone(&self) -> Timestamp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timestamp

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

Formats the value using the given formatter.

impl Decode for Timestamp

fn decode<I: Input>(input: &mut I) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<'de> Deserialize<'de> for Timestamp

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Timestamp

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

Formats the value using the given formatter.

impl Encode for Timestamp

fn encode_to<T: Output + ?Sized>(&self, writer: &mut T)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl From<Time> for Timestamp

fn from(tendermint_time: Time) -> Self

Converts to this type from the input type.

impl FromStr for Timestamp

type Err = ParseTimestampError

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 Timestamp

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 Timestamp

fn schema_name() -> String

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for Timestamp

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Duration> for Timestamp

type Output = Result<Timestamp, TimestampOverflowError>

The resulting type after applying the - operator.

fn sub(self, duration: Duration) -> Result<Self, TimestampOverflowError>

Performs the - operation.

impl TypeInfo for Timestamp

type Identity = Timestamp

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Copy for Timestamp

impl Eq for Timestamp

impl StructuralPartialEq for Timestamp