Enum PeerAddr 

#[non_exhaustive]
pub enum PeerAddr {
    Direct(SocketAddr),
    Pt(PtTarget),
}

Represents the address of a connected peer used for a tor channel.

Clever observer here would see that this is basically a tor_linkspec::ChannelMethod which has a Direct variant with a vector of address which is incoherent with the semantic of “where we are connected to”.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Direct(SocketAddr)

The socket address we are directly connected to.

Pt(PtTarget)

The pluggable transport target used to connect.

Note that this is not a specific address but the PT transport details. We keep those because if the PtTargetAddr happens to be None, we need to compare the transport name and settings to match a channel.

Implementations

impl PeerAddr

pub(crate) const UNSPECIFIED: Self

Unspecified address used for placeholder in unit tests.

pub fn netinfo_addr(&self) -> Option<IpAddr>

Return the IP address that should be used in the NETINFO cell.

A None value implies we didn’t use an IP address to connect (see PtTarget). The tor_cell::chancell::msg::Netinfo interface will treat a None as an IPv4 unspecified address (0.0.0.0).

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

Return the socket address of this peer.

None means that this is a PT and doesn’t use an internet address. One example is it uses a hostname.

Trait Implementations

impl Clone for PeerAddr

fn clone(&self) -> PeerAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PeerAddr

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

Formats the value using the given formatter.

impl Display for PeerAddr

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

Formats the value using the given formatter.

impl From<&PeerAddr> for Option<BridgeAddr>

Useful because BridgeAddr are used in some Error struct.

fn from(t: &PeerAddr) -> Self

Converts to this type from the input type.

impl From<PtTarget> for PeerAddr

Available on crate feature pt-client only.

fn from(t: PtTarget) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for PeerAddr

fn from(sa: SocketAddr) -> Self

Converts to this type from the input type.

impl PartialEq for PeerAddr

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

impl StructuralPartialEq for PeerAddr