Struct PeerId

pub struct PeerId { /* private fields */ }

Available on crate feature peerid only.

Identifier of a peer of the network.

The data is a CIDv0 compatible multihash of the protobuf encoded public key of the peer as specified in specs/peer-ids.

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, ParseError>

Parses a PeerId from bytes.

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

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

Available on crate feature rand only.

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.

Trait Implementations

impl AsRef<Multihash<64>> for PeerId

fn as_ref(&self) -> &Multihash<64>

Converts this type into a shared reference of the (usually inferred) input type.

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<'de> Deserialize<'de> for PeerId

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PeerId

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

Formats the value using the given formatter.

impl From<&PublicKey> for PeerId

fn from(key: &PublicKey) -> PeerId

Converts to this type from the input type.

impl From<PeerId> for Multihash<64>

fn from(peer_id: PeerId) -> Self

Converts to this type from the input type.

impl From<PeerId> for Vec<u8>

fn from(peer_id: PeerId) -> Self

Converts to this type from the input type.

impl From<PublicKey> for PeerId

fn from(key: PublicKey) -> PeerId

Converts to this type from the input type.

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 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PeerId

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

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

fn partial_cmp(&self, other: &PeerId) -> 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 Serialize for PeerId

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Multihash<64>> for PeerId

type Error = Multihash<64>

The type returned in the event of a conversion error.

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

Performs the conversion.

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

impl Eq for PeerId

impl StructuralPartialEq for PeerId