Struct iprs::peer_id::PeerId

pub struct PeerId { /* fields omitted */ }

Unique identifier of a peer in the network.

Peer IDs are derived by hashing the encoded public-key with multihash.

PublicKey to PeerId:

• Encode the public key as described in the keys section.
• If the length of the serialized bytes is less than or equal to 42, compute the "identity" multihash of the serialized bytes. In other words, no hashing is performed, but the multihash format is still followed. The idea here is that if the serialized byte array is short enough, we can fit it in a multihash verbatim without having to condense it using a hash function.
• If the length is greater than 42, then hash it using it using the SHA256 multihash.

Implementations

impl PeerId

pub fn from_public_key(key: PublicKey) -> Result<PeerId>

Builds a PeerId from a public key.

pub fn generate() -> Result<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 from_text(text: &str) -> Result<PeerId>

Decode a base encoded PeerId, human readable text. Peerid format can either be in legacy format (base58btc) or multi-base encoded CID format.

pub fn to_base58btc(&self) -> Result<String>

Encode peer-id to base58btc format.

pub fn to_base_text(&self, base: Base) -> Result<String>

Encode peer-id to multi-base encoded CID format.

pub fn encode(&self) -> Result<Vec<u8>>

Encode PeerId into multihash-binary-format.

NOTE: This byte representation is not necessarily consistent with equality of peer IDs. That is, two peer IDs may be considered equal while having a different byte representation.

pub fn decode(buf: &[u8]) -> Result<(PeerId, &[u8])>

Decode PeerId from multihash-binary-format.

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.

pub fn to_short_string(&self) -> String

Return the peer-id as condensed version of PeerID::to_string().

pub fn to_public_key(&self) -> Result<Option<PublicKey>>

Sometimes PeerID could be encoded using IDENTITY hash. Which means, unlike when it is encoded as public-key's hash, it is possible to extract the public-key from the peer-id.

Trait Implementations

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 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 Eq for PeerId

impl From<Multihash> for PeerId

fn from(mh: Multihash) -> Self

Performs the conversion.

impl From<PeerId> for Multihash

fn from(peer_id: PeerId) -> Self

Performs the conversion.

impl Hash for PeerId

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

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 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 ==.

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

This method tests for !=.

impl StructuralEq for PeerId