Struct SubnetConfig

pub struct SubnetConfig {
    pub(crate) subnets_family_v4: u8,
    pub(crate) subnets_family_v6: u8,
}

Configuration for determining when two relays have addresses “too close” in the network.

Used by [Relay::low_level_details().in_same_subnet()].

Fields

subnets_family_v4: u8

Consider IPv4 nodes in the same /x to be the same family.

If this value is 0, all nodes with IPv4 addresses will be in the same family. If this value is above 32, then no nodes will be placed im the same family based on their IPv4 addresses.

subnets_family_v6: u8

Consider IPv6 nodes in the same /x to be the same family.

If this value is 0, all nodes with IPv6 addresses will be in the same family. If this value is above 128, then no nodes will be placed im the same family based on their IPv6 addresses.

Implementations

impl SubnetConfig

pub fn new(subnets_family_v4: u8, subnets_family_v6: u8) -> Self

Construct a new SubnetConfig from a pair of bit prefix lengths.

The values are clamped to the appropriate ranges if they are out-of-bounds.

pub fn no_addresses_match() -> SubnetConfig

Construct a new SubnetConfig such that addresses are not in the same family with anything–not even with themselves.

pub fn addrs_in_same_subnet(&self, a: &IpAddr, b: &IpAddr) -> bool

Return true if the two addresses in the same subnet, according to this configuration.

pub fn any_addrs_in_same_subnet<T, U>(&self, a: &T, b: &U) -> bool

where T: HasAddrs, U: HasAddrs,

Return true if any of the addresses in a shares a subnet with any of the addresses in b, according to this configuration.

pub fn union(&self, other: &Self) -> Self

Return a new subnet configuration that is the union of self and other.

That is, return a subnet configuration that puts all addresses in the same subnet if and only if at least one of self and other would put them in the same subnet.

Trait Implementations

impl Clone for SubnetConfig

fn clone(&self) -> SubnetConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubnetConfig

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

Formats the value using the given formatter.

impl Default for SubnetConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubnetConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SubnetConfig

fn eq(&self, other: &SubnetConfig) -> 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 Copy for SubnetConfig

impl Eq for SubnetConfig

impl StructuralPartialEq for SubnetConfig