Struct lnp::payment::ChannelId

pub struct ChannelId(_);

Lightning network channel Id

Implementations

impl ChannelId

pub fn with(funding_outpoint: OutPoint) -> Self

pub fn is_wildcard(&self) -> bool

With some lightning messages (like error) channel id consisting of all zeros has a special meaning of “applicable to all opened channels”. This function allow to detect this kind of ChannelId

Trait Implementations

impl AsMut<<ChannelId as Wrapper>::Inner> for ChannelId

fn as_mut(&mut self) -> &mut Self::Inner

Performs the conversion.

impl AsRef<<ChannelId as Wrapper>::Inner> for ChannelId

fn as_ref(&self) -> &Self::Inner

Performs the conversion.

impl Borrow<<ChannelId as Wrapper>::Inner> for ChannelId

fn borrow(&self) -> &Self::Inner

Immutably borrows from an owned value.

impl BorrowMut<<ChannelId as Wrapper>::Inner> for ChannelId

fn borrow_mut(&mut self) -> &mut Self::Inner

Mutably borrows from an owned value.

impl Clone for ChannelId

fn clone(&self) -> ChannelId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ChannelId

impl Debug for ChannelId

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

Formats the value using the given formatter.

impl Default for ChannelId

fn default() -> ChannelId

Returns the “default value” for a type.

impl Deref for ChannelId

type Target = Self::Inner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ChannelId

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for ChannelId

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

Formats the value using the given formatter.

impl Eq for ChannelId

impl From<ChannelId> for TempChannelId

fn from(id: ChannelId) -> Self

Performs the conversion.

impl From<Slice32> for ChannelId

fn from(v: Slice32) -> Self

Performs the conversion.

impl From<TempChannelId> for ChannelId

fn from(temp: TempChannelId) -> Self

Performs the conversion.

impl FromHex for ChannelId

fn from_byte_iter<I>(iter: I) -> Result<Self, Error> where
    I: Iterator<Item = Result<u8, Error>> + ExactSizeIterator + DoubleEndedIterator, 

Produce an object from a byte iterator

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

Produce an object from a hex string

impl FromStr for ChannelId

type Err = <Self::Inner as FromStr>::Err

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 ChannelId

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LightningDecode for ChannelId

fn lightning_decode<D: Read>(d: D) -> Result<Self, Error>

pub fn lightning_deserialize(data: &impl AsRef<[u8]>) -> Result<Self, Error>

impl LightningEncode for ChannelId

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

pub fn lightning_serialize(&self) -> Vec<u8, Global>

impl LowerHex for ChannelId

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

Formats the value using the given formatter.

impl Ord for ChannelId

fn cmp(&self, other: &ChannelId) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ChannelId> for ChannelId

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

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

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

This method tests for !=.

impl PartialOrd<ChannelId> for ChannelId

fn partial_cmp(&self, other: &ChannelId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StrictDecode for ChannelId

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given [std::io::Reader] instance; must either construct an instance or return implementation-specific error type.

pub fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using [strict_decode()]

impl StrictEncode for ChannelId

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given [std::io::Writer] instance; must return result with either amount of bytes encoded – or implementation-specific error type.

pub fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using [strict_encode()] function

impl StructuralEq for ChannelId

impl StructuralPartialEq for ChannelId

impl UpperHex for ChannelId

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

Formats the value using the given formatter.

impl Wrapper for ChannelId

type Inner = Slice32

Inner type wrapped by the current newtype

fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &Self::Inner

Returns reference to the inner representation for the wrapper type

fn as_inner_mut(&mut self) -> &mut Self::Inner

Returns a mutable reference to the inner representation for the wrapper type

fn into_inner(self) -> Self::Inner

Unwraps the wrapper returning the inner type

pub fn to_inner(&self) -> Self::Inner

Clones inner data of the wrapped type and return them

pub fn copy(&self) -> Self where
    Self::Inner: Copy, 

Copies the wrapped type