Struct ibc::timestamp::Timestamp

pub struct Timestamp { /* private fields */ }

A newtype 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<Timestamp, 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() -> Timestamp

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: &Timestamp) -> 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::timestamp::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::default();
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: &Timestamp) -> Expiry

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

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

Checks whether the current timestamp is strictly more advanced than the other timestamp. Return true if so, and false otherwise.

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<Timestamp, TimestampOverflowError>

Performs the + operation.

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

fn default() -> Timestamp

Returns the “default value” for a 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

Formats the value using the given formatter.

impl From<Time> for Timestamp

fn from(tendermint_time: Time) -> Timestamp

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Timestamp> 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 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<Timestamp, TimestampOverflowError>

Performs the - operation.

impl Copy for Timestamp

impl Eq for Timestamp

impl StructuralEq for Timestamp

impl StructuralPartialEq for Timestamp