Struct tor_guardmgr::FirstHop

pub struct FirstHop {
    pub(crate) sample: Option<GuardSetSelector>,
    pub(crate) inner: FirstHopInner,
}

Representation of a guard or fallback, as returned by GuardMgr::select_guard().

Fields

sample: Option<GuardSetSelector>

The sample from which this guard was taken, or None if this is a fallback.

inner: FirstHopInner

Information about connecting to (or through) this guard.

Implementations

impl FirstHop

pub(crate) fn first_hop_id(&self) -> FirstHopId

Return a new FirstHopId for this FirstHop.

pub fn get_relay<'a>(&self, netdir: &'a NetDir) -> Option<Relay<'a>>

Look up this guard in netdir.

pub fn as_circ_target(&self) -> Option<&OwnedCircTarget>

If possible, return a view of this object that can be used to build a circuit.

pub(crate) fn chan_target_mut(&mut self) -> &mut OwnedChanTarget

Return a view of this as an OwnedChanTarget.

pub(crate) fn lookup_bridge_circ_target(&mut self, bridges: &BridgeSet)

Available on crate feature bridge-client only.

If possible and appropriate, find a circuit target in bridges for this FirstHop, and make this FirstHop a viable circuit target.

(By default, any FirstHop that a GuardSet returns will have enough information to be a ChanTarget, but it will be lacking the additional network information in CircTarget¹ necessary for us to build a multi-hop circuit through it. If this FirstHop is a regular non-bridge Relay, then the CircMgr will later look up that circuit information itself from the network directory. But if this FirstHop is a bridge, then we need to find that information in the BridgeSet, since the CircMgr does not keep track of the BridgeSet.)

---

1. For example, supported protocol versions and ntor keys. ↩

pub(crate) fn contains_circ_target(&self) -> bool

Available on crate feature bridge-client only.

Return true if this FirstHop contains circuit target information.

This is true if lookup_bridge_circ_target() has been called, and it successfully found the circuit target information.

Trait Implementations

impl ChanTarget for FirstHop

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

where Self: Sized,

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

impl Clone for FirstHop

fn clone(&self) -> FirstHop

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FirstHop

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

Formats the value using the given formatter.

impl HasAddrs for FirstHop

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

Return the addresses listed for this server.

impl HasChanMethod for FirstHop

fn chan_method(&self) -> ChannelMethod

Return the known ways to contact this

impl HasRelayIds for FirstHop

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.