Enum ChannelMethod 

#[non_exhaustive]
pub enum ChannelMethod {
    Direct(Vec<SocketAddr>),
    Pluggable(PtTarget),
}

The way to approach a single relay in order to open a channel.

For direct connections, this is simply an address. For connections via a pluggable transport, this includes information about the transport, and any address and settings information that transport requires.

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(Vec<SocketAddr>)

Connect to the relay directly at one of several addresses.

Pluggable(PtTarget)

Available on crate feature pt-client only.

Connect to a bridge relay via a pluggable transport.

Implementations

impl ChannelMethod

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

Return all the advertized socket addresses to which this method may connect.

Returns Some(&[]) if there is no way to connect to this target, and None if this target does not use SocketAddr to connect

NOTE that these are not necessarily an address to which you can open a TCP connection! If this ChannelMethod is using a non-Direct transport, then this address will be interpreted by that transport’s implementation.

pub fn target_addr(&self) -> Option<PtTargetAddr>

Return a BridgeAddr that this ChannelMethod uses.

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

Return the SocketAddr if this method is ChannelMethod::Direct and there is one and only one available address.

This is single address requirement is very important as this call is used during the channel handshake on which we need the actual peer address we are connected to and not all the possibilities.

When connecting or accepting, that addres is put in the OwnedChanTarget and so this extracts it.

pub fn is_direct(&self) -> bool

Return true if this is a method for a direct connection.

pub fn transport_id(&self) -> TransportId

Return an identifier for the Transport to be used by this ChannelMethod.

pub fn retain_addrs<P>(&mut self, pred: P) -> Result<(), RetainAddrsError>

where P: Fn(&SocketAddr) -> bool,

Change this ChannelMethod by removing every socket address that does not satisfy pred.

Hostname and None addresses are never removed.

Return an error if we have removed every address.

pub fn contained_by(&self, other: &ChannelMethod) -> bool

Return true if every method to contact self is also a method to contact other.

Trait Implementations

impl Clone for ChannelMethod

fn clone(&self) -> ChannelMethod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelMethod

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

Formats the value using the given formatter.

impl HasAddrs for ChannelMethod

fn addrs(&self) -> impl Iterator<Item = SocketAddr>

Return the addresses listed for this server.

impl Hash for ChannelMethod

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 ChannelMethod

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

impl StructuralPartialEq for ChannelMethod