Struct libp2p_core::PeerId

pub struct PeerId { /* fields omitted */ }

Identifier of a peer of the network.

The data is a multihash of the public key of the peer.

Methods

impl PeerId

pub fn from_public_key(key: PublicKey) -> PeerId

Builds a PeerId from a public key.

pub fn from_bytes(data: Vec<u8>) -> Result<PeerId, Vec<u8>>

Checks whether data is a valid PeerId. If so, returns the PeerId. If not, returns back the data as an error.

pub fn from_multihash(data: Multihash) -> Result<PeerId, Multihash>

Turns a Multihash into a PeerId. If the multihash doesn't use the correct algorithm, returns back the data as an error.

pub fn random() -> PeerId

Generates a random peer ID from a cryptographically secure PRNG.

This is useful for randomly walking on a DHT, or for testing purposes.

pub fn into_bytes(self) -> Vec<u8>

Returns a raw bytes representation of this PeerId.

Note that this is not the same as the public key of the peer.

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

Returns a raw bytes representation of this PeerId.

Note that this is not the same as the public key of the peer.

pub fn to_base58(&self) -> String

Returns a base-58 encoded string of this PeerId.

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

Returns the raw bytes of the hash of this PeerId.

pub fn is_public_key(&self, public_key: &PublicKey) -> Option<bool>

Checks whether the public key passed as parameter matches the public key of this PeerId.

Returns None if this PeerIds hash algorithm is not supported when encoding the given public key, otherwise Some boolean as the result of an equality check.

Trait Implementations

impl ConnectionInfo for PeerId

type PeerId = PeerId

Identity of the node we are connected to.

fn peer_id(&self) -> &PeerId

Returns the identity of the node we are connected to on this connection.

impl Eq for PeerId

impl Into<Multihash> for PeerId

fn into(self) -> Multihash

Performs the conversion.

impl PartialEq<PeerId> for PeerId

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

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

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

This method tests for !=.

impl PartialEq<Multihash> for PeerId

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

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

#[must_use]

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

This method tests for !=.

impl PartialEq<PeerId> for Multihash

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

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

#[must_use]

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

This method tests for !=.

impl Clone for PeerId

fn clone(&self) -> PeerId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl AsRef<Multihash> for PeerId

fn as_ref(&self) -> &Multihash

Performs the conversion.

impl AsRef<[u8]> for PeerId

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

Performs the conversion.

impl From<PublicKey> for PeerId

fn from(key: PublicKey) -> PeerId

Performs the conversion.

impl Debug for PeerId

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

Formats the value using the given formatter.

impl Display for PeerId

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

Formats the value using the given formatter.

impl Hash for PeerId

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, 

Feeds a slice of this type into the given [Hasher].

impl FromStr for PeerId

type Err = ParseError

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 TryFrom<Vec<u8>> for PeerId

type Error = Vec<u8>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Multihash> for PeerId

type Error = Multihash

The type returned in the event of a conversion error.

fn try_from(value: Multihash) -> Result<Self, Self::Error>

Performs the conversion.