Struct PeerInfo 

pub struct PeerInfo {
    addr: PeerAddr,
    ids: RelayIds,
}

Represents the actual information about the peer of a crate::channel::Channel.

This type exists because tor_linkspec::OwnedChanTarget is overloaded and used for multiple purposes.

An tor_linkspec::OwnedChanTarget represents an intended target, rather than what is actually used. In addition, it stores peer addresses both in a vector inside the struct and within the ChannelMethod. When connecting to the peer, our code returns an tor_linkspec::OwnedChanTarget whose ChannelMethod has been filtered to contain only the address that was actually used. However, the tor_linkspec::HasAddrs trait reads from the address vector, which creates a disconnect between the intent and the actual usage.

This struct resolves that ambiguity by storing the concrete peer information that was actually used. It provides clear, unambiguous guarantees about the peer associated with the channel.

Fields

addr: PeerAddr

Actual target address used for the channel connection.

ids: RelayIds

Identities that this relay provides.

Implementations

impl PeerInfo

pub(crate) const EMPTY: Self

Empty peer info used for placeholder in unit tests.

pub(crate) fn new(addr: PeerAddr, ids: RelayIds) -> Self

Constructor.

pub(crate) fn addr(&self) -> &PeerAddr

Return a reference to the target address.

pub(crate) fn ids(&self) -> &RelayIds

Return a reference to the RelayIds of this channel target.

pub fn matches_chan_method(&self, method: &ChannelMethod) -> bool

Return true iff the given ChannelMethod matches us.

A ChannelMethod is semantically for the concept of a “target” as in a connection goal. And so, this method returns true or false if the target method matches the peer information. This is used to choose the best channel in the channel manager.

A match is true if: * Direct: Our address is contained in the method set of addresses. * Pluggable: Our address is equal to the method’s target.

Trait Implementations

impl Clone for PeerInfo

fn clone(&self) -> PeerInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PeerInfo

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

Formats the value using the given formatter.

impl Display for PeerInfo

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

Formats the value using the given formatter.

impl HasRelayIds for PeerInfo

fn identity(&self, key_type: RelayIdType) -> Option<RelayIdRef<'_>>

Return the identity of this relay whose type is key_type, or None if the relay has no such identity.

fn identities(&self) -> RelayIdIter<'_, Self>

Return an iterator over all of the identities held by this object.

fn ed_identity(&self) -> Option<&Ed25519Identity>

Return the ed25519 identity for this relay if it has one.

fn rsa_identity(&self) -> Option<&RsaIdentity>

Return the RSA identity for this relay if it has one.

fn has_identity(&self, id: RelayIdRef<'_>) -> bool

Check whether the provided Id is a known identity of this relay.

fn has_any_identity(&self) -> bool

Return true if this object has any known identity.

fn same_relay_ids<T>(&self, other: &T) -> bool

where T: HasRelayIds + ?Sized,

Return true if this object has exactly the same relay IDs as other.

fn has_all_relay_ids_from<T>(&self, other: &T) -> bool

where T: HasRelayIds + ?Sized,

Return true if this object has every relay ID that other does.

fn has_any_relay_id_from<T>(&self, other: &T) -> bool

where T: HasRelayIds + ?Sized,

Return true if this object has any relay ID that other has.

fn cmp_by_relay_ids<T>(&self, other: &T) -> Ordering

where T: HasRelayIds + ?Sized,

Compare this object to another HasRelayIds.

fn display_relay_ids(&self) -> DisplayRelayIds<'_, Self>

Return a reference to this object suitable for formatting its HasRelayIds members.