Struct PathConfig 

pub struct PathConfig {
    ipv4_subnet_family_prefix: u8,
    ipv6_subnet_family_prefix: u8,
    pub(crate) long_lived_ports: HashSet<u16>,
    pub(crate) reachable_addrs: Vec<AddrPortPattern>,
}

Rules for building paths over the network.

This type is immutable once constructed. To build one, use PathConfigBuilder, or deserialize it from a string.

You may change the PathConfig on a running Arti client. Doing so changes paths that are constructed in the future, and prevents requests from being attached to existing circuits, if the configuration has become more restrictive.

Fields

ipv4_subnet_family_prefix: u8

Set the length of a bit-prefix for a default IPv4 subnet-family.

Any two relays will be considered to belong to the same family if their IPv4 addresses share at least this many initial bits.

ipv6_subnet_family_prefix: u8

Set the length of a bit-prefix for a default IPv6 subnet-family.

Any two relays will be considered to belong to the same family if their IPv6 addresses share at least this many initial bits.

long_lived_ports: HashSet<u16>

A set of ports that need to be sent over Stable circuits.

reachable_addrs: Vec<AddrPortPattern>

The set of addresses to which we’re willing to make direct connections.

Implementations

impl PathConfig

pub fn builder() -> PathConfigBuilder

Return a new [PathConfig Builder] to construct an instance of this type.

impl PathConfig

pub fn subnet_config(&self) -> SubnetConfig

Return a subnet configuration based on these rules.

pub(crate) fn at_least_as_permissive_as(&self, other: &Self) -> bool

Return true if this configuration is at least as permissive as other.

In other words, in other words, return true if every circuit permitted by other would also be permitted by this configuration.

We use this function to decide when circuits must be discarded. Therefore, it is okay to return “false” inaccurately, but we should never return “true” inaccurately.

pub(crate) fn build_guard_filter(&self) -> GuardFilter

Return a new GuardFilter reflecting the rules in this configuration.

pub(crate) fn relay_selection_config(&self) -> RelaySelectionConfig<'_>

Return a new RelaySelectionConfig reflecting the rules in this configuration.

Trait Implementations

impl AsRef<PathConfig> for TestConfig

fn as_ref(&self) -> &PathConfig

Converts this type into a shared reference of the (usually inferred) input type.

impl Buildable for PathConfig

type Builder = PathConfigBuilder

The type that constructs this Buildable.

fn builder() -> PathConfigBuilder

Return a new Builder for this type.

impl Clone for PathConfig

fn clone(&self) -> PathConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathConfig

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

Formats the value using the given formatter.

impl Default for PathConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PathConfig

fn eq(&self, other: &PathConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PathConfig

impl StructuralPartialEq for PathConfig