Struct lightning_invoice::PositiveTimestamp

pub struct PositiveTimestamp(_);

A timestamp that refers to a date after 1 January 1970 which means its representation as UNIX timestamp is positive.

Invariants

The UNIX timestamp representing the stored time has to be positive and small enough so that a EpiryTime can be added to it without an overflow.

Implementations

impl PositiveTimestamp

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

Create a new PositiveTimestamp from a unix timestamp in the Range 0...SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME, otherwise return a CreationError::TimestampOutOfBounds.

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

Create a new PositiveTimestamp from a SystemTime with a corresponding unix timestamp in the Range 0...SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME, otherwise return a CreationError::TimestampOutOfBounds.

pub fn as_unix_timestamp(&self) -> u64

Returns the UNIX timestamp representing the stored time

pub fn as_time(&self) -> &SystemTime

Returns a reference to the internal SystemTime time representation

Methods from Deref<Target = SystemTime>

pub const UNIX_EPOCH: SystemTime

pub fn duration_since(
    &self,
    earlier: SystemTime
) -> Result<Duration, SystemTimeError>

Returns the amount of time elapsed from an earlier point in time.

This function may fail because measurements taken earlier are not guaranteed to always be before later measurements (due to anomalies such as the system clock being adjusted either forwards or backwards). Instant can be used to measure elapsed time without this risk of failure.

If successful, Ok(Duration) is returned where the duration represents the amount of time elapsed from the specified measurement to this one.

Returns an Err if earlier is later than self, and the error contains how far from self the time is.

Examples

use std::time::SystemTime;

let sys_time = SystemTime::now();
let new_sys_time = SystemTime::now();
let difference = new_sys_time.duration_since(sys_time)
    .expect("Clock may have gone backwards");
println!("{:?}", difference);

pub fn elapsed(&self) -> Result<Duration, SystemTimeError>

Returns the difference between the clock time when this system time was created, and the current clock time.

This function may fail as the underlying system clock is susceptible to drift and updates (e.g., the system clock could go backwards), so this function may not always succeed. If successful, Ok(Duration) is returned where the duration represents the amount of time elapsed from this time measurement to the current time.

To measure elapsed time reliably, use Instant instead.

Returns an Err if self is later than the current system time, and the error contains how far from the current system time self is.

Examples

use std::thread::sleep;
use std::time::{Duration, SystemTime};

let sys_time = SystemTime::now();
let one_sec = Duration::from_secs(1);
sleep(one_sec);
assert!(sys_time.elapsed().unwrap() >= one_sec);

pub fn checked_add(&self, duration: Duration) -> Option<SystemTime>

Returns Some(t) where t is the time self + duration if t can be represented as SystemTime (which means it's inside the bounds of the underlying data structure), None otherwise.

pub fn checked_sub(&self, duration: Duration) -> Option<SystemTime>

Returns Some(t) where t is the time self - duration if t can be represented as SystemTime (which means it's inside the bounds of the underlying data structure), None otherwise.

Trait Implementations

impl Clone for PositiveTimestamp

pub fn clone(&self) -> PositiveTimestamp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PositiveTimestamp

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

Formats the value using the given formatter.

impl Deref for PositiveTimestamp

type Target = SystemTime

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl Eq for PositiveTimestamp

impl FromBase32 for PositiveTimestamp

type Err = ParseError

The associated error which can be returned from parsing (e.g. because of bad padding).

pub fn from_base32(b32: &[u5]) -> Result<Self, Self::Err>

Convert a base32 slice to Self.

impl Into<SystemTime> for PositiveTimestamp

pub fn into(self) -> SystemTime

Performs the conversion.

impl PartialEq<PositiveTimestamp> for PositiveTimestamp

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

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

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

This method tests for !=.

impl StructuralEq for PositiveTimestamp

impl StructuralPartialEq for PositiveTimestamp

impl ToBase32 for PositiveTimestamp

pub fn write_base32<W: WriteBase32>(
    &self,
    writer: &mut W
) -> Result<(), <W as WriteBase32>::Err>

Encode as base32 and write it to the supplied writer Implementations shouldn't allocate.

pub fn to_base32(&self) -> Vec<u5, Global>

Convert Self to base32 vector