Struct RelayDetails

pub struct RelayDetails<'a>(pub(crate) &'a Relay<'a>);

A view for lower-level details about a Relay.

Most callers should avoid using this structure; they should instead call higher-level functions like those in the tor-relay-selection crate.

Tuple Fields

0: &'a Relay<'a>

Implementations

impl<'a> RelayDetails<'a>

pub fn supports_exit_port_ipv4(&self, port: u16) -> bool

Return true if this relay allows exiting to port on IPv4.

pub fn supports_exit_port_ipv6(&self, port: u16) -> bool

Return true if this relay allows exiting to port on IPv6.

pub fn is_dir_cache(&self) -> bool

Return true if this relay is suitable for use as a directory cache.

pub fn is_flagged_fast(&self) -> bool

Return true if this relay has the “Fast” flag.

Most relays have this flag. It indicates that the relay is suitable for circuits that need more than a minimal amount of bandwidth.

pub fn is_flagged_stable(&self) -> bool

Return true if this relay has the “Stable” flag.

Most relays have this flag. It indicates that the relay is suitable for long-lived circuits.

pub fn is_hs_intro_point(&self) -> bool

Return true if this relay is a potential HS introduction point

pub fn is_hs_rend_point(&self) -> bool

Return true if this relay is a potential HS rendezvous point

pub fn is_suitable_as_guard(&self) -> bool

Return true if this relay is suitable for use as a newly sampled guard, or for continuing to use as a guard.

pub fn in_same_subnet( &self, other: &Relay<'_>, subnet_config: &SubnetConfig, ) -> bool

Return true if both relays are in the same subnet, as configured by subnet_config.

Two relays are considered to be in the same subnet if they have IPv4 addresses with the same subnets_family_v4-bit prefix, or if they have IPv6 addresses with the same subnets_family_v6-bit prefix.

pub fn in_same_family( &self, other: &Relay<'_>, family_rules: FamilyRules, ) -> bool

Return true if both relays are in the same family.

(Every relay is considered to be in the same family as itself.)

pub fn policies_allow_some_port(&self) -> bool

Return true if there are any ports for which this Relay can be used for exit traffic.

(Returns false if this relay doesn’t allow exit traffic, or if it has been flagged as a bad exit.)

pub fn ipv4_policy(&self) -> Arc<PortPolicy>

Return the IPv4 exit policy for this relay. If the relay has been marked BadExit, return an empty policy

pub fn ipv6_policy(&self) -> Arc<PortPolicy>

Return the IPv6 exit policy for this relay. If the relay has been marked BadExit, return an empty policy

pub fn ipv4_declared_policy(&self) -> &Arc<PortPolicy>

Return the IPv4 exit policy declared by this relay.

In contrast to RelayDetails::ipv4_policy, this does not verify if the relay is marked BadExit.

pub fn ipv6_declared_policy(&self) -> &Arc<PortPolicy>

Return the IPv6 exit policy declared by this relay.

In contrast to RelayDetails::ipv6_policy, this does not verify if the relay is marked BadExit.

Trait Implementations

impl<'a> Clone for RelayDetails<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.