[][src]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.


impl KnownPeer[src]

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

create a new Node with the given SocketAddr.

pub fn id(&self) -> &NetworkID[src]

access the unique identifier of the Node.

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

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

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

these are the Topic and the InterestLevel associated.

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

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>[src]

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[src]

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[src]

impl Eq for KnownPeer[src]

impl PartialEq<KnownPeer> for KnownPeer[src]

impl Debug for KnownPeer[src]

impl StructuralPartialEq for KnownPeer[src]

impl StructuralEq for KnownPeer[src]

impl<'de> Deserialize<'de> for KnownPeer[src]

impl Serialize for KnownPeer[src]

Auto Trait Implementations

Blanket Implementations

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

impl<T> From<T> for T[src]

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

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

impl<T> DeserializeOwned for T where
    T: Deserialize<'de>, 

impl<T> FromCast<T> for T

impl<T, U> Cast<U> for T where
    U: FromCast<T>, 

impl<T> FromBits<T> for T

impl<T, U> IntoBits<U> for T where
    U: FromBits<T>, 

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<Q, K> Equivalent<K> for Q where
    K: Borrow<Q> + ?Sized,
    Q: Eq + ?Sized

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