Struct ExitPathBuilder

pub(crate) struct ExitPathBuilder {
    inner: ExitPathBuilderInner,
    compatible_with: Option<OwnedChanTarget>,
    require_stability: bool,
}

A PathBuilder that builds a path to an exit relay supporting a given set of ports.

NOTE: The name of this type is no longer completely apt: given some circuits, it is happy to build a circuit ending at a non-exit.

Fields

inner: ExitPathBuilderInner

The inner ExitPathBuilder state.

compatible_with: Option<OwnedChanTarget>

If present, a “target” that every chosen relay must be able to share a circuit with with.

require_stability: bool

If true, all relays on this path must be Stable.

Implementations

impl ExitPathBuilder

pub(crate) fn from_target_ports( wantports: impl IntoIterator<Item = TargetPort>, ) -> Self

Create a new builder that will try to get an exit relay containing all the ports in ports.

If the list of ports is empty, tries to get any exit relay at all.

pub(crate) fn in_given_country( country: CountryCode, wantports: impl IntoIterator<Item = TargetPort>, ) -> Self

Available on crate feature geoip only.

Create a new builder that will try to get an exit relay in country, containing all the ports in ports.

If the list of ports is empty, it is disregarded.

pub(crate) fn for_any_exit() -> Self

Create a new builder that will try to get any exit relay at all.

pub(crate) fn pick_path<'a, R: Rng, RT: Runtime>( &self, rng: &mut R, netdir: DirInfo<'a>, guards: &GuardMgr<RT>, config: &PathConfig, now: SystemTime, ) -> Result<(TorPath<'a>, GuardMonitor, GuardUsable)>

Try to create and return a path corresponding to the requirements of this builder.

pub(crate) fn for_timeout_testing() -> Self

Create a new builder that will try to get an exit relay, but which will be satisfied with a non-exit relay.

pub(crate) fn require_stability(&mut self, require_stability: bool) -> &mut Self

Indicate that middle and exit relays on this circuit need (or do not need) to have the Stable flag.

Trait Implementations

impl AnonymousPathBuilder for ExitPathBuilder

fn compatible_with(&self) -> Option<&OwnedChanTarget>

Return the “target” that every chosen relay must be able to share a circuit with with.

fn pick_exit<'a, R: Rng>( &self, rng: &mut R, netdir: &'a NetDir, guard_exclusion: RelayExclusion<'a>, rs_cfg: &RelaySelectionConfig<'_>, ) -> Result<(Relay<'a>, RelayUsage)>

Find a suitable exit node from either the chosen exit or from the network directory.

fn path_kind(&self) -> &'static str

Return a short description of the path we’re trying to build, for error reporting purposes.