Struct ClientPaymentId 

#[repr(transparent)]
pub struct ClientPaymentId(pub [u8; 32]);

A unique, client-generated id for payment types (onchain send, ln spontaneous send) that need an extra id for idempotency.

Its primary purpose is to prevent accidental double payments. Internal structure (if any) is opaque to the node.

Tuple Fields

0: [u8; 32]

Implementations

impl ClientPaymentId

pub fn generate() -> ClientPaymentId

Generate a random ClientPaymentId.

Trait Implementations

impl AsRef<[u8]> for ClientPaymentId

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<[u8; 32]> for ClientPaymentId

fn as_ref(&self) -> &[u8; 32]

Converts this type into a shared reference of the (usually inferred) input type.

impl ByteArray<32> for ClientPaymentId

fn from_array(array: [u8; 32]) -> ClientPaymentId

fn to_array(&self) -> [u8; 32]

fn as_array(&self) -> &[u8; 32]

fn as_slice(&self) -> &[u8]

fn to_vec(&self) -> Vec<u8>

fn try_from_slice(slice: &[u8]) -> Result<Self, TryFromSliceError>

fn try_from_vec(vec: Vec<u8>) -> Result<Self, TryFromSliceError>

fn from_hex(s: &str) -> Result<Self, DecodeError>

fn to_hex(&self) -> String

fn as_hex_display(&self) -> HexDisplay<'_>

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

impl Clone for ClientPaymentId

fn clone(&self) -> ClientPaymentId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientPaymentId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientPaymentId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ClientPaymentId

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

Formats the value using the given formatter.

impl FromHex for ClientPaymentId

fn from_hex(s: &str) -> Result<ClientPaymentId, DecodeError>

impl FromStr for ClientPaymentId

type Err = DecodeError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<ClientPaymentId, <ClientPaymentId as FromStr>::Err>

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

impl Hash for ClientPaymentId

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 ClientPaymentId

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

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

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

type From = [u8; 32]

fn ref_cast(_from: &<ClientPaymentId as RefCast>::From) -> &ClientPaymentId

fn ref_cast_mut( _from: &mut <ClientPaymentId as RefCast>::From, ) -> &mut ClientPaymentId

impl Serialize for ClientPaymentId

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 TryFrom<PaymentId> for ClientPaymentId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(id: PaymentId) -> Result<ClientPaymentId, Error>

Performs the conversion.

impl Copy for ClientPaymentId

impl Eq for ClientPaymentId

impl StructuralPartialEq for ClientPaymentId