Struct PaymentSecret

pub struct PaymentSecret(pub [u8; 32]);

payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together

This is not exported to bindings users as we just use [u8; 32] directly

Tuple Fields

0: [u8; 32]

Trait Implementations

impl Base32Len for PaymentSecret

fn base32_len(&self) -> usize

Calculate the base32 serialized length

impl Clone for PaymentSecret

fn clone(&self) -> PaymentSecret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentSecret

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

Formats the value using the given formatter.

impl FromBase32 for PaymentSecret

type Err = Error

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

fn from_base32(field_data: &[u5]) -> Result<PaymentSecret, Error>

Convert a base32 slice to Self.

impl Hash for PaymentSecret

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 PaymentSecret

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

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

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

fn read<R>(r: &mut R) -> Result<PaymentSecret, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl ToBase32 for PaymentSecret

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

where W: WriteBase32,

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

fn to_base32(&self) -> Vec<u5>

Convert Self to base32 vector

impl Writeable for PaymentSecret

fn write<W>(&self, w: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

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

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Copy for PaymentSecret

impl Eq for PaymentSecret

impl StructuralPartialEq for PaymentSecret