Struct Preimage 

pub struct Preimage(/* private fields */);

A 32-byte secret preimage used for HTLC-based payments.

Implementations

impl Preimage

pub fn to_byte_array(self) -> [u8; 32]

Convert into underlying byte array.

pub fn from_byte_array(bytes: [u8; 32]) -> Self

Convert from byte array.

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

Create from byte slice.

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

Convert into a byte vector.

impl Preimage

pub fn random() -> Preimage

Generate a new random preimage.

pub fn compute_payment_hash(&self) -> PaymentHash

Hashes the preimage into the payment hash

Trait Implementations

impl AsRef<[u8]> for Preimage

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

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

impl Clone for Preimage

fn clone(&self) -> Preimage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Preimage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Preimage

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Preimage

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

Formats the value using the given formatter.

impl<'a> DisplayHex for &'a Preimage

type Display = <&'a [u8; 32] as DisplayHex>::Display

The type providing fmt::Display implementation.

fn as_hex(self) -> Self::Display

Display Self as a continuous sequence of ASCII hex chars.

fn to_lower_hex_string(self) -> String

Create a lower-hex-encoded string.

fn to_upper_hex_string(self) -> String

Create an upper-hex-encoded string.

fn to_hex_string(self, case: Case) -> String

Create a hex-encoded string.

fn append_hex_to_string(self, case: Case, string: &mut String)

Appends hex-encoded content to an existing String.

fn hex_reserve_suggestion(self) -> usize

Hints how much bytes to reserve when creating a String.

impl From<[u8; 32]> for Preimage

fn from(inner: [u8; 32]) -> Self

Converts to this type from the input type.

impl From<Preimage> for [u8; 32]

fn from(p: Preimage) -> Self

Converts to this type from the input type.

impl From<Preimage> for PaymentHash

fn from(preimage: Preimage) -> Self

Converts to this type from the input type.

impl FromStr for Preimage

type Err = HexToArrayError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Preimage

fn hash<__H: Hasher>(&self, state: &mut __H)

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 PartialEq for Preimage

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

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for Preimage

type Error = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from(slice: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Preimage

type Error = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from(vec: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Preimage

impl Eq for Preimage

impl StructuralPartialEq for Preimage