Struct lightning_invoice::ExpiryTime

pub struct ExpiryTime(_);

Positive duration that defines when (relatively to the timestamp) in the future the invoice expires

Invariants

The number of seconds this expiry time represents has to be in the range 0...(SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME) to avoid overflows when adding it to a timestamp

Implementations

impl ExpiryTime

pub fn from_seconds(seconds: u64) -> Result<ExpiryTime, CreationError>

Construct an ExpiryTime from seconds. If there exists a PositiveTimestamp which would overflow on adding the EpiryTime to it then this function will return a CreationError::ExpiryTimeOutOfBounds.

pub fn from_duration(duration: Duration) -> Result<ExpiryTime, CreationError>

Construct an ExpiryTime from a Duration. If there exists a PositiveTimestamp which would overflow on adding the EpiryTime to it then this function will return a CreationError::ExpiryTimeOutOfBounds.

pub fn as_seconds(&self) -> u64

Returns the expiry time in seconds

pub fn as_duration(&self) -> &Duration

Returns a reference to the underlying Duration (=expiry time)

Trait Implementations

impl Base32Len for ExpiryTime

pub fn base32_len(&self) -> usize

Calculate the base32 serialized length

impl Clone for ExpiryTime

pub fn clone(&self) -> ExpiryTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExpiryTime

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

Formats the value using the given formatter.

impl Eq for ExpiryTime

impl FromBase32 for ExpiryTime

type Err = ParseError

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

pub fn from_base32(field_data: &[u5]) -> Result<ExpiryTime, ParseError>

Convert a base32 slice to Self.

impl PartialEq<ExpiryTime> for ExpiryTime

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

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

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

This method tests for !=.

impl StructuralEq for ExpiryTime

impl StructuralPartialEq for ExpiryTime

impl ToBase32 for ExpiryTime

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