Struct libp2p_core::PeerId

[+] Show declaration

pub struct PeerId { /* fields omitted */ }

[−] Expand description

Identifier of a peer of the network.

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

Implementations

impl PeerId[−]

pub fn from_public_key(key: PublicKey) -> PeerId[−]

Builds a PeerId from a public key.

pub fn from_bytes(data: &[u8]) -> Result<PeerId, Error>[−]

Parses a PeerId from bytes.

pub fn from_multihash(multihash: Multihash) -> Result<PeerId, Multihash>[−]

Tries to turn a Multihash into a PeerId.

If the multihash does not use a valid hashing algorithm for peer IDs, or the hash value does not satisfy the constraints for a hashed peer ID, it is returned as an Err.

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 to_bytes(&self) -> Vec<u8>[−]

Returns a raw bytes representation of this PeerId.

pub fn to_base58(&self) -> String[−]

Returns a base-58 encoded string 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 AsRef<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for PeerId[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &Multihash[−]

Performs the conversion.

impl Clone for PeerId[+]

[+] Show hidden undocumented items

fn clone(&self) -> PeerId[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PeerId

impl Debug for PeerId[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Display for PeerId[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for PeerId

impl From<PeerId> for Multihash[+]

[+] Show hidden undocumented items

fn from(peer_id: PeerId) -> Self[−]

Performs the conversion.

impl From<PeerId> for Vec<u8>[+]

[+] Show hidden undocumented items

fn from(peer_id: PeerId) -> Self[−]

Performs the conversion.

impl From<PublicKey> for PeerId[+]

[+] Show hidden undocumented items

fn from(key: PublicKey) -> PeerId[−]

Performs the conversion.

impl FromStr for PeerId[+]

[+] Show hidden undocumented items

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 Hash for PeerId[+]

[+] Show hidden undocumented items

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 Ord for PeerId[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &PeerId) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

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

Restrict a value to a certain interval.

impl PartialEq<PeerId> for PeerId[+]

[+] Show hidden undocumented items

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 PartialOrd<PeerId> for PeerId[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &PeerId) -> Option<Ordering>[−]

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

[+] Expand attributes

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

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

[+] Expand attributes

#[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.

[+] Expand attributes

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

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

[+] Expand attributes

#[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 StructuralEq for PeerId

impl StructuralPartialEq for PeerId

impl TryFrom<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for PeerId[+]

[+] Show hidden undocumented items

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.

impl TryFrom<Vec<u8, Global>> for PeerId[+]

[+] Show hidden undocumented items

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.