Struct Timestamp

pub struct Timestamp { /* private fields */ }

A newtype wrapper over PrimitiveDateTime which serves as the foundational basis for capturing timestamps. It is used directly to keep track of host timestamps.

It is also encoded as part of the ibc::channel::types::timeout::TimeoutTimestamp type for expressly keeping track of timeout timestamps.

Implementations

impl Timestamp

pub fn from_nanoseconds(nanoseconds: u64) -> Timestamp

pub fn from_unix_timestamp( secs: u64, nanos: u32, ) -> Result<Timestamp, TimestampError>

pub fn now() -> Timestamp

Returns a Timestamp representation of the current time.

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

Computes the duration difference of another Timestamp from the current one. Returns the difference in time as an core::time::Duration.

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);
let utx = tx.nanoseconds();
assert_eq!(utx, max);
let min = u64::MIN;
let ti = Timestamp::from_nanoseconds(min);
let uti = ti.nanoseconds();
assert_eq!(uti, min);

Trait Implementations

impl Add<Duration> for Timestamp

type Output = Result<Timestamp, TimestampError>

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> <Timestamp as Add<Duration>>::Output

Performs the + operation.

impl<'a> Arbitrary<'a> for Timestamp

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Timestamp, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl BorshDeserialize for Timestamp

fn deserialize_reader<R>(reader: &mut R) -> Result<Timestamp, Error>

where R: Read,

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>(&self, writer: &mut W) -> Result<(), Error>

where W: Write,

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<(), Error>

Formats the value using the given formatter.

impl Decode for Timestamp

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

where I: Input,

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<Timestamp, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Timestamp

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

Formats the value using the given formatter.

impl Encode for Timestamp

fn encode_to<T>(&self, writer: &mut T)

where T: Output + ?Sized,

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<Timestamp> for OffsetDateTime

fn from(t: Timestamp) -> OffsetDateTime

Converts to this type from the input type.

impl From<Timestamp> for TimeoutTimestamp

fn from(timestamp: Timestamp) -> TimeoutTimestamp

Converts to this type from the input type.

impl From<Timestamp> for Timestamp

fn from(value: Timestamp) -> Timestamp

Converts to this type from the input type.

impl FromStr for Timestamp

type Err = TimestampError

The associated error which can be returned from parsing.

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

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

impl Hash for Timestamp

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<T> IntoHostTime<T> for Timestamp

where T: TryFrom<OffsetDateTime>,

fn into_host_time(self) -> Result<T, TimestampError>

Converts a Timestamp into another time representation of type T.

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(generator: &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,

Restrict a value to a certain interval.

impl PartialEq for Timestamp

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

Tests for self and other values to be equal, and is used by ==.

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

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

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 Protobuf<Timestamp> for Timestamp

fn encode<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode into a buffer in Protobuf format.

fn encode_length_delimited<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode with a length-delimiter to a buffer in Protobuf format.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode an instance from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode a length-delimited instance from the buffer.

fn encoded_len(self) -> usize

Returns the encoded length of the message without a length delimiter.

fn encode_vec(self) -> Vec<u8>

Encodes into a Protobuf-encoded Vec<u8>.

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

Constructor that attempts to decode a Protobuf-encoded instance from a Vec<u8> (or equivalent).

fn encode_length_delimited_vec(self) -> Vec<u8>

Encode with a length-delimiter to a Vec<u8> Protobuf-encoded message.

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

Constructor that attempts to decode a Protobuf-encoded instance with a length-delimiter from a Vec<u8> or equivalent.

impl Serialize for Timestamp

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Duration> for Timestamp

type Output = Result<Timestamp, TimestampError>

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> <Timestamp as Sub<Duration>>::Output

Performs the - operation.

impl TryFrom<OffsetDateTime> for Timestamp

type Error = TimestampError

The type returned in the event of a conversion error.

fn try_from( t: OffsetDateTime, ) -> Result<Timestamp, <Timestamp as TryFrom<OffsetDateTime>>::Error>

Performs the conversion.

impl TryFrom<Timestamp> for Timestamp

type Error = TimestampError

The type returned in the event of a conversion error.

fn try_from( raw: Timestamp, ) -> Result<Timestamp, <Timestamp as TryFrom<Timestamp>>::Error>

Performs the conversion.

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