Struct sc_peerset::PeerId

pub struct PeerId { /* private fields */ }
Expand description

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

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 try_from_multiaddr(address: &Multiaddr) -> Option<PeerId>

Tries to extract a PeerId from the given [Multiaddr].

In case the given [Multiaddr] ends with /p2p/<peer-id>, this function will return the encapsulated PeerId, otherwise it will return None.

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

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<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. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for PeerId

§

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

Formats the value using the given formatter. Read more
§

impl Display for PeerId

§

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

Formats the value using the given formatter. Read more
§

impl From<&PublicKey> for PeerId

§

fn from(key: &PublicKey) -> PeerId

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<PeerId, <PeerId as FromStr>::Err>

Parses a string s to return a value of this type. Read more
§

impl Hash for PeerId

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl Ord for PeerId

§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
§

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 ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl PartialOrd<PeerId> for PeerId

§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

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<PeerId, <PeerId as TryFrom<Multihash<64>>>::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.
§

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

Performs the conversion.
§

impl Copy for PeerId

§

impl Eq for PeerId

§

impl StructuralEq for PeerId

§

impl StructuralPartialEq for PeerId

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
§

impl<T> SaturatedConversion for T

§

fn saturated_from<T>(t: T) -> Selfwhere Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more
§

fn saturated_into<T>(self) -> Twhere Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T, S> UniqueSaturatedInto<T> for Swhere T: Bounded, S: TryInto<T>,

§

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V