Struct sc_network::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.

Implementations

impl PeerId

pub fn from_public_key(key: PublicKey) -> PeerId

Builds a PeerId from a public key.

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

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(
    multihash: MultihashGeneric<Code>
) -> Result<PeerId, MultihashGeneric<Code>>

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 into_bytes(self) -> Vec<u8, Global>

Returns a raw bytes representation of this PeerId.

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 as per into_bytes.

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

Returns a raw bytes representation of this PeerId.

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 as per as_bytes.

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

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 as per AsRef<[u8]>.

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

Performs the conversion.

impl Borrow<[u8]> for PeerId

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

Immutably borrows from an owned value.

impl Clone for PeerId

pub fn clone(&self) -> PeerId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConnectionInfo for PeerId

type PeerId = PeerId

Identity of the node we are connected to.

pub fn peer_id(&self) -> &PeerId

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

impl Debug for PeerId

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

Formats the value using the given formatter.

impl Display for PeerId

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

Formats the value using the given formatter.

impl Eq for PeerId

impl From<PeerId> for MultihashGeneric<Code>

pub fn from(peer_id: PeerId) -> MultihashGeneric<Code>

Performs the conversion.

impl From<PublicKey> for PeerId

pub fn from(key: PublicKey) -> PeerId

Performs the conversion.

impl FromStr for PeerId

type Err = ParseError

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<PeerId, <PeerId as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for PeerId

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

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

pub fn cmp(&self, other: &PeerId) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<PeerId> for PeerId

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

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

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

This method tests for !=.

impl PartialOrd<PeerId> for PeerId

pub fn partial_cmp(&self, other: &PeerId) -> Option<Ordering>

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

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

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

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

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

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

#[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 TryFrom<MultihashGeneric<Code>> for PeerId

type Error = MultihashGeneric<Code>

The type returned in the event of a conversion error.

pub fn try_from(
    value: MultihashGeneric<Code>
) -> Result<PeerId, <PeerId as TryFrom<MultihashGeneric<Code>>>::Error>

Performs the conversion.

impl TryFrom<Vec<u8, Global>> for PeerId

type Error = Vec<u8, Global>

The type returned in the event of a conversion error.

pub fn try_from(
    value: Vec<u8, Global>
) -> Result<PeerId, <PeerId as TryFrom<Vec<u8, Global>>>::Error>

Performs the conversion.