Struct PaymentCreatedIndex 

pub struct PaymentCreatedIndex {
    pub created_at: TimestampMs,
    pub id: PaymentId,
}

A unique, ordered payment identifier: (created_at, payment_id).

Essentially a (TimestampMs, PaymentId) which:

1. retains uniqueness per payment, and
2. is ordered first by created_at timestamp and then by PaymentId.

String-serialized as <created_at>-<id>, e.g.: “0002683862736062841-ln_003dd23aec576e7d0d85aa991ff9c2dc471fd7c863ff31b93bfbb02836eb56b5”.

The string’s lexicographic order matches the struct’s Ord.

Recommendation to SDK users: Prefer this as the primary identifier for a payment, as you can degenerate it into a String while retaining timestamp-based lexicographic sorting for free, e.g. BTreeMap<String, Payment> or BTreeMap<PaymentCreatedIndex, Payment>. Fall back to the inner PaymentId only if that’s all you have, e.g. a BOLT 11 invoice’s payment hash.

Fields

created_at: TimestampMs

id: PaymentId

Implementations

impl PaymentCreatedIndex

pub const MIN: PaymentCreatedIndex

The index that is lexicographically <= all other indexes.

pub const MAX: PaymentCreatedIndex

The index that is lexicographically >= all other indexes.

Trait Implementations

impl Clone for PaymentCreatedIndex

fn clone(&self) -> PaymentCreatedIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentCreatedIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaymentCreatedIndex

where PaymentCreatedIndex: FromStr, <PaymentCreatedIndex as FromStr>::Err: Display,

fn deserialize<__D>( deserializer: __D, ) -> Result<PaymentCreatedIndex, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PaymentCreatedIndex

<created_at>-<id>

When serializing to string, pad the timestamp with leading zeroes (up to the maximum number of digits in an i64) so that the lexicographic ordering is equivalent to the non-serialized ordering.

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

Formats the value using the given formatter.

impl FromStr for PaymentCreatedIndex

<created_at>-<id>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(createdat_id: &str) -> Result<PaymentCreatedIndex, Error>

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

impl Hash for PaymentCreatedIndex

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

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

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

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

where PaymentCreatedIndex: Display,

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 Copy for PaymentCreatedIndex

impl Eq for PaymentCreatedIndex

impl StructuralPartialEq for PaymentCreatedIndex