Struct Peer 

pub struct Peer {
    pub public_key: CommsPublicKey,
    pub node_id: NodeId,
    pub addresses: MultiaddressesWithStats,
    pub flags: PeerFlags,
    pub banned_until: Option<NaiveDateTime>,
    pub banned_reason: String,
    pub features: PeerFeatures,
    pub supported_protocols: Vec<ProtocolId>,
    pub added_at: NaiveDateTime,
    pub user_agent: String,
    pub metadata: HashMap<u8, Vec<u8>>,
    pub deleted_at: Option<NaiveDateTime>,
    /* private fields */
}

A Peer represents a communication peer that is identified by a Public Key and NodeId. The Peer struct maintains a collection of the NetAddressesWithStats that this Peer can be reached by. The struct also maintains a set of flags describing the status of the Peer.

Fields

public_key: CommsPublicKey

Public key of the peer

node_id: NodeId

NodeId of the peer

addresses: MultiaddressesWithStats

Peer’s addresses

flags: PeerFlags

Flags for the peer.

banned_until: Option<NaiveDateTime>

banned_reason: String

features: PeerFeatures

Features supported by the peer

supported_protocols: Vec<ProtocolId>

Protocols supported by the peer. This should not be considered a definitive list of supported protocols and is used as information for more efficient protocol negotiation.

added_at: NaiveDateTime

Timestamp of when the peer was added to this nodes peer list

user_agent: String

User agent advertised by the peer

metadata: HashMap<u8, Vec<u8>>

Metadata field. This field is for use by upstream clients to record extra info about a peer. We use a hashmap here so that we can use more than one “info set”

deleted_at: Option<NaiveDateTime>

If this peer has been deleted.

Implementations

impl Peer

pub fn new( public_key: CommsPublicKey, node_id: NodeId, addresses: MultiaddressesWithStats, flags: PeerFlags, features: PeerFeatures, supported_protocols: Vec<ProtocolId>, user_agent: String, ) -> Peer

Constructs a new peer.

pub fn new_with_stats( id: Option<PeerId>, public_key: CommsPublicKey, node_id: NodeId, addresses: MultiaddressesWithStats, flags: PeerFlags, banned_until: Option<NaiveDateTime>, banned_reason: String, features: PeerFeatures, supported_protocols: Vec<ProtocolId>, added_at: NaiveDateTime, user_agent: String, metadata: HashMap<u8, Vec<u8>>, deleted_at: Option<NaiveDateTime>, ) -> Peer

Constructs a new peer with stats.

pub fn id(&self) -> PeerId

Returns the peers local id if this peer is persisted.

This method panics if the peer does not have a PeerId, and therefore is not persisted. If the caller should be sure that the peer is persisted before calling this function. This can be checked by using Peer::is_persisted.

pub fn merge(&mut self, other: &Peer)

Merges the data with another peer. This is usually used to update a peer before it is saved to the database so that data is not overwritten

pub fn is_persisted(&self) -> bool

pub fn supported_protocols(&self) -> &[ProtocolId]

Returns a slice of Protocols known to be supported by the peer. This should not be considered a definitive list of supported protocols

pub fn last_connect_attempt(&self) -> Option<NaiveDateTime>

pub fn last_address_used(&self) -> Option<Multiaddr>

The last address used to connect to the peer

pub fn is_offline(&self) -> bool

Returns true if the peer is marked as offline

pub fn offline_at(&self) -> Option<NaiveDateTime>

pub fn offline_since(&self) -> Option<Duration>

The length of time since a peer was marked as offline

pub fn last_seen(&self) -> Option<NaiveDateTime>

Provides that date time of the last successful interaction with the peer

pub fn all_addresses_failed(&self) -> bool

Provides info about the failure status of all addresses

pub fn last_seen_since(&self) -> Option<Duration>

Provides that length of time since the last successful interaction with the peer

pub fn is_banned(&self) -> bool

Returns the ban status of the peer

pub fn reason_banned(&self) -> &str

Returns the ban status of the peer

pub fn ban_for(&mut self, duration: Duration, reason: String)

Bans the peer for a specified duration

pub fn unban(&mut self)

Unban the peer

pub fn banned_until(&self) -> Option<&NaiveDateTime>

pub fn set_metadata(&mut self, key: u8, data: Vec<u8>) -> Option<Vec<u8>>

This will store metadata inside of the metadata field in the peer. It will return None if the value was empty and the old value if the value was updated

pub fn get_metadata(&self, key: u8) -> Option<&Vec<u8>>

This will return the value in the metadata field. It will return None if the key is not present

pub fn update_addresses( &mut self, addresses: &[Multiaddr], source: &PeerAddressSource, ) -> &mut Self

Update the peer’s addresses. This call will invalidate the identity signature.

pub fn set_features(&mut self, features: PeerFeatures) -> &mut Self

Update the peer’s features. This call will invalidate the identity signature if the features differ.

pub fn add_flags(&mut self, flags: PeerFlags) -> &mut Self

pub fn is_seed(&self) -> bool

pub fn to_short_string(&self) -> String

Trait Implementations

impl Clone for Peer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Peer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Peer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Peer

Display Peer as [peer_id]: <pubkey>

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

Formats the value using the given formatter.

impl Eq for Peer

impl Hash for Peer

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 PartialEq for Peer

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Peer

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<(NewPeerSql, Vec<NewMultiaddrWithStatsSql>)> for Peer

type Error = StorageError

The type returned in the event of a conversion error.

fn try_from( (peer_query, addresses_query): (NewPeerSql, Vec<NewMultiaddrWithStatsSql>), ) -> Result<Self, Self::Error>

Performs the conversion.