Enum Family 

pub enum Family {
    V6,
    V4,
}

An IP address family: IPv6 (preferred) or IPv4 (fallback).

This is the axis the whole crate reasons over — local capability, peer reachability, dial order, and the winning connection are all expressed in terms of a Family. IPv6 sorts before IPv4 everywhere so the ecosystem’s IPv6-first rule (CLAUDE.md §5.2) falls out of the ordinary Ord/PartialOrd derive.

Variants

V6

IPv6 — the preferred family.

V4

IPv4 — the fallback family.

Implementations

impl Family

pub const PREFERENCE: [Family; 2]

The preference-ordered list of both families, IPv6 first.

pub fn of(addr: &SocketAddr) -> Family

The family of a socket address.

An IPv4-mapped IPv6 address (::ffff:a.b.c.d) is classified as Family::V4: it is IPv4 reachability wearing an IPv6 costume, so treating it as V6 would let an IPv6-only host think it can reach a v4-only peer. Canonicalizing first keeps the family tag honest.

Trait Implementations

impl Clone for Family

fn clone(&self) -> Family

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Family

impl Debug for Family

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

Formats the value using the given formatter.

impl Eq for Family

impl Hash for Family

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Family

fn cmp(&self, other: &Family) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Family

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Family

fn partial_cmp(&self, other: &Family) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Family