Struct tor_relay_selection::RelayUsage

pub struct RelayUsage { /* private fields */ }

Description for how we plan to use a single relay.

Implementations

impl RelayUsage

pub fn any_exit(_cfg: &RelaySelectionConfig<'_>) -> Self

Require a relay that exits to at least one port.

This usage is generally suitable as the final relay for a testing circuit of some kind, or for a circuit that needs to look like an exit circuit without actually being useful for any exit in particular.

pub fn exit_to_all_ports( cfg: &RelaySelectionConfig<'_>, ports: Vec<TargetPort>, ) -> Self

Require a relay that exits to every port in a given list.

pub fn exit_to_any_port( cfg: &RelaySelectionConfig<'_>, ports: Vec<TargetPort>, ) -> Self

Require a relay that exits to at least one port in a given list.

pub fn middle_relay(known_final_hop_usage: Option<&RelayUsage>) -> Self

Require a relay that is suitable for a middle relay.

If known_final_hop_usage is provided, then the middle relay must support any additional properties needed in order to build a circuit for the usage of the final hop.

If known_final_hop_usage is not provided, then the middle relay must support all possible such additional properties.

(Note that providing a known_final_hop_usage can only weaken the requirements of this usage.)

pub fn new_intro_point() -> Self

Require a relay that is suitable as a newly selected introduction point.

This usage is suitable for selecting new introduction points for an onion service. When deciding whether to keep an introduction point, use RelayUsage::continuing_intro_point.

pub fn continuing_intro_point() -> Self

Require a relay that is suitable to keep using as a pre-existing introduction point.

pub fn new_guard() -> Self

Require a relay that is suitable as a newly selected guard.

This usage is suitable for selecting new guards. When deciding whether to keep a guard, use RelayUsage::continuing_guard.

pub fn continuing_guard() -> Self

Require a relay that is suitable to keep using as a pre-existing guard.

pub fn vanguard() -> Self

Available on crate feature vanguards only.

Require a relay that is suitable as a vanguard.

pub fn directory_cache() -> Self

Require a relay that is suitable to use for a directory request.

Note that this usage is suitable for fetching consensuses, authority certificates, descriptors and microdescriptors. It is not suitable for use with the HsDir system.

Trait Implementations

impl Clone for RelayUsage

fn clone(&self) -> RelayUsage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelayUsage

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

Formats the value using the given formatter.

impl LowLevelRelayPredicate for RelayUsage

fn low_level_predicate_permits_relay(&self, relay_in: &Relay<'_>) -> bool

Return true if relay provides this predicate.