Struct PositiveTimestamp

pub struct PositiveTimestamp(/* private fields */);

A timestamp that refers to a date after 1 January 1970.

Invariants

The Unix timestamp representing the stored time has to be positive and no greater than MAX_TIMESTAMP.

Implementations

impl PositiveTimestamp

pub fn from_unix_timestamp(unix_seconds: u64) -> Result<Self, CreationError>

Creates a PositiveTimestamp from a Unix timestamp in the range 0..=MAX_TIMESTAMP.

Otherwise, returns a CreationError::TimestampOutOfBounds.

pub fn from_system_time(time: SystemTime) -> Result<Self, CreationError>

Available on crate feature std only.

Creates a PositiveTimestamp from a SystemTime with a corresponding Unix timestamp in the range 0..=MAX_TIMESTAMP.

Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.

Otherwise, returns a CreationError::TimestampOutOfBounds.

pub fn from_duration_since_epoch( duration: Duration, ) -> Result<Self, CreationError>

Creates a PositiveTimestamp from a Duration since the Unix epoch in the range 0..=MAX_TIMESTAMP.

Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.

Otherwise, returns a CreationError::TimestampOutOfBounds.

pub fn as_unix_timestamp(&self) -> u64

Returns the Unix timestamp representing the stored time

pub fn as_duration_since_epoch(&self) -> Duration

Returns the duration of the stored time since the Unix epoch

pub fn as_time(&self) -> SystemTime

Available on crate feature std only.

Returns the SystemTime representing the stored time

Trait Implementations

impl Clone for PositiveTimestamp

fn clone(&self) -> PositiveTimestamp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PositiveTimestamp

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

Formats the value using the given formatter.

impl From<PositiveTimestamp> for Duration

fn from(val: PositiveTimestamp) -> Self

Converts to this type from the input type.

impl From<PositiveTimestamp> for SystemTime

Available on crate feature std only.

fn from(val: PositiveTimestamp) -> Self

Converts to this type from the input type.

impl Hash for PositiveTimestamp

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

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

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

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

impl StructuralPartialEq for PositiveTimestamp