Struct PeerRecord

pub struct PeerRecord { /* private fields */ }

Represents a peer routing record.

Peer records are designed to be distributable and carry a signature by being wrapped in a signed envelope. For more information see RFC0003 of the libp2p specifications: https://github.com/libp2p/specs/blob/master/RFC/0003-routing-records.md

Implementations

impl PeerRecord

pub fn from_signed_envelope( envelope: SignedEnvelope, ) -> Result<PeerRecord, FromEnvelopeError>

Attempt to re-construct a PeerRecord from a SignedEnvelope.

If this function succeeds, the SignedEnvelope contained a peer record with a valid signature and can hence be considered authenticated.

pub fn new( key: &Keypair, addresses: Vec<Multiaddr>, ) -> Result<PeerRecord, SigningError>

Construct a new PeerRecord by authenticating the provided addresses with the given key.

This is the same key that is used for authenticating every libp2p connection of your application, i.e. what you use when setting up your crate::transport::Transport.

pub fn to_signed_envelope(&self) -> SignedEnvelope

pub fn into_signed_envelope(self) -> SignedEnvelope

pub fn peer_id(&self) -> PeerId

pub fn seq(&self) -> u64

pub fn addresses(&self) -> &[Multiaddr]

Trait Implementations

impl Clone for PeerRecord

fn clone(&self) -> PeerRecord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PeerRecord

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

Formats the value using the given formatter.

impl PartialEq for PeerRecord

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

impl StructuralPartialEq for PeerRecord