Struct BridgeRelay

pub struct BridgeRelay<'a> {
    bridge_line: &'a BridgeConfig,
    desc: Option<BridgeDesc>,
    addrs: Vec<SocketAddr>,
}

Available on crate feature bridge-client only.

The information about a Bridge that is necessary to connect to it and send it traffic.

Fields

bridge_line: &'a BridgeConfig

The local configurations for the bridge.

This is always necessary, since it without it we can’t know whether any pluggable transports are needed.

desc: Option<BridgeDesc>

A descriptor for the bridge.

If present, it MUST have every RelayId that the bridge_line does.

BridgeDesc is an Arc<> internally, so we aren’t so worried about having this be owned.

addrs: Vec<SocketAddr>

All the known addresses for the bridge.

This includes the contact addresses in bridge_line, plus any addresses listed in desc.

TODO(nickm): I wish we didn’t have to reallocate a for this, but the API requires that we can return a reference to a slice of this.

TODO(nickm): perhaps, construct this lazily?

Implementations

impl<'a> BridgeRelay<'a>

pub(crate) fn new( bridge_line: &'a BridgeConfig, desc: Option<BridgeDesc>, ) -> Self

Construct a new BridgeRelay from its parts.

pub fn has_descriptor(&self) -> bool

Return true if this BridgeRelay has a known descriptor and can be used for relays.

pub fn as_relay_with_desc(&self) -> Option<BridgeRelayWithDesc<'_>>

If we have enough information about this relay to build a circuit through it, return a BridgeRelayWithDesc for it.

Trait Implementations

impl<'a> ChanTarget for BridgeRelay<'a>

fn display_chan_target(&self) -> DisplayChanTarget<'_, Self>

where Self: Sized,

Return a reference to this object suitable for formatting its ChanTarget-specific members.

impl<'a> Clone for BridgeRelay<'a>

fn clone(&self) -> BridgeRelay<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BridgeRelay<'a>

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

Formats the value using the given formatter.

impl<'a> HasAddrs for BridgeRelay<'a>

fn addrs(&self) -> &[SocketAddr]

Note: Remember (from the documentation at HasAddrs) that these are not necessarily addresses at which the Bridge can be reached. For those, use chan_method. These addresses are used for establishing GeoIp and family info.

impl<'a> HasChanMethod for BridgeRelay<'a>

fn chan_method(&self) -> ChannelMethod

Return the known ways to contact this

impl<'a> HasRelayIds for BridgeRelay<'a>

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.