Struct HsPathBuilder

pub(crate) struct HsPathBuilder {
    compatible_with: Option<OwnedChanTarget>,
    stem_kind: HsCircStemKind,
    circ_kind: Option<HsCircKind>,
}

Available on crate feature hs-common only.

A path builder for hidden service circuits.

See the hspath docs for more details.

Fields

compatible_with: Option<OwnedChanTarget>

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

Ignored if vanguards are in use.

stem_kind: HsCircStemKind

The type of circuit stem to build.

This is only used if vanguards are enabled.

circ_kind: Option<HsCircKind>

If present, ensure that the circuit stem is suitable for use as (a stem for) the given kind of circuit.

Implementations

impl HsPathBuilder

pub(crate) fn new( compatible_with: Option<OwnedChanTarget>, stem_kind: HsCircStemKind, circ_kind: Option<HsCircKind>, ) -> Self

Create a new builder that will try to build a three-hop non-exit path for use with the onion services protocols that is compatible with being extended to an optional given relay.

(The provided relay is not included in the built path: we only ensure that the path we build does not have any features that would stop us extending it to that relay as a fourth hop.)

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 for a hidden service circuit stem.

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

Available on crate feature vanguards only.

Try to create and return a path for a hidden service circuit stem.

If vanguards are disabled, this has the same behavior as pick_path.

Trait Implementations

impl AnonymousPathBuilder for HsPathBuilder

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

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

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

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

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.