Struct NodeId

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

A compressed pubkey which a node uses to sign announcements and decode HTLCs routed through it.

This type stores a simple byte array which is not checked for validity (i.e. that it describes a point which lies on the secp256k1 curve), unlike PublicKey, as validity checking would otherwise represent a large portion of NetworkGraph deserialization time (and RGS application).

Implementations

impl NodeId

pub fn from_pubkey(pubkey: &PublicKey) -> Self

Create a new NodeId from a public key

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

Create a new NodeId from a slice of bytes

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

Get the public key slice from this NodeId

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

Get the public key as an array from this NodeId

pub fn as_pubkey(&self) -> Result<PublicKey, Error>

Get the public key from this NodeId

Trait Implementations

impl Clone for NodeId

fn clone(&self) -> NodeId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeId

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

Formats the value using the given formatter.

impl Display for NodeId

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

Formats the value using the given formatter.

impl From<PublicKey> for NodeId

fn from(pubkey: PublicKey) -> Self

Converts to this type from the input type.

impl FromStr for NodeId

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 NodeId

fn hash<H: Hasher>(&self, hasher: &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 Ord for NodeId

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

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

fn partial_cmp(&self, other: &Self) -> 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 NodeId

fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl TryFrom<NodeId> for PublicKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(node_id: NodeId) -> Result<Self, Self::Error>

Performs the conversion.

impl Writeable for NodeId

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

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 NodeId

impl Eq for NodeId

impl StructuralPartialEq for NodeId