Struct libp3p::peer::KnownPeer

pub struct KnownPeer { /* fields omitted */ }

The data associated to a Node.

This can be gossiped through the topology in order to update the topology of new nodes or better neighbors.

Methods

impl KnownPeer

pub fn new_with(id: NetworkID, address: SocketAddr) -> Self

create a new Node with the given SocketAddr.

pub fn id(&self) -> &NetworkID

access the unique identifier of the Node.

pub fn address(&self) -> &Option<SocketAddr>

get the Node's address (mean to contact it)

pub fn subscriptions(&self) -> impl Iterator<Item = (&Topic, &InterestLevel)>

these are the Topic and the InterestLevel associated.

pub fn subscribers(&self) -> impl Iterator<Item = &NetworkID>

the nodes that are related to this Node

pub fn add_subscription(
    &mut self,
    subscription: Subscription
) -> Option<InterestLevel>

add a subscription

pub fn remove_subscription(&mut self, topic: Topic) -> Option<InterestLevel>

remove a subscriptions

pub fn common_subscriptions<'a>(
    &'a self,
    other: &'a Self
) -> impl Iterator<Item = &'a Topic>

list all common subscriptions between the two nodes

pub fn common_subscribers<'a>(
    &'a self,
    other: &'a Self
) -> impl Iterator<Item = &'a NetworkID>

list all common subscribers between the two nodes

pub fn proximity(&self, other: &Self) -> Proximity

compute the relative proximity between these 2 nodes.

This is based on the subscription. The more 2 nodes have subscription in common the closer they are.

Trait Implementations

impl Clone for KnownPeer

fn clone(&self) -> KnownPeer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for KnownPeer

impl PartialEq<KnownPeer> for KnownPeer

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

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

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

This method tests for !=.

impl Debug for KnownPeer

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

Formats the value using the given formatter.

impl StructuralPartialEq for KnownPeer

impl StructuralEq for KnownPeer

impl<'de> Deserialize<'de> for KnownPeer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for KnownPeer

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

Serialize this value into the given Serde serializer.