Struct AddrAndZone

pub struct AddrAndZone<A, Z>(/* private fields */);

A witness type for an address and a scope zone.

AddrAndZone carries an address that may have a scope, alongside the particular zone of that scope. The zone is also referred to as a “scope identifier” in some systems (such as Linux).

Note that although AddrAndZone acts as a witness type, it does not implement Witness since it carries both the address and scoping information, and not only the witnessed address.

Implementations

impl<A: ScopeableAddress, Z> AddrAndZone<A, Z>

pub fn new(addr: A, zone: Z) -> Option<Self>

Constructs a new AddrAndZone, returning Some only if the provided addr’s scope can have a zone (addr.scope().can_have_zone()).

impl<A: ScopeableAddress + IpAddress, Z> AddrAndZone<A, Z>

pub fn new_not_loopback(addr: A, zone: Z) -> Option<Self>

Constructs a new AddrAndZone, returning Some only if the provided addr’s scope can have a zone (addr.scope().can_have_zone()) and addr is not a loopback address.

impl<A, Z> AddrAndZone<A, Z>

pub const unsafe fn new_unchecked(addr: A, zone: Z) -> Self

Constructs a new AddrAndZone without checking to see if addr’s scope can have a zone.

Safety

It is up to the caller to make sure that addr’s scope can have a zone to avoid breaking the guarantees of AddrAndZone.

pub fn into_addr_scope_id(self) -> (A, Z)

Consumes this AddrAndZone, returning the address and zone separately.

pub fn map_zone<Y>(self, f: impl FnOnce(Z) -> Y) -> AddrAndZone<A, Y>

Translates the zone identifier using the provided function.

pub fn map_addr<B>(self, f: impl FnOnce(A) -> B) -> AddrAndZone<B, Z>

Translates the address using f.

pub fn try_map_zone<Y, E>( self, f: impl FnOnce(Z) -> Result<Y, E>, ) -> Result<AddrAndZone<A, Y>, E>

Attempts to translate the zone identifier using the provided function.

pub fn addr(&self) -> A

where A: Copy,

Accesses the addr for this AddrAndZone.

pub fn as_ref(&self) -> AddrAndZone<&A, &Z>

Converts from AddrAndZone<A, Z> to AddrAndZone<&A, &Z>.

Trait Implementations

impl<A: Clone, Z: Clone> Clone for AddrAndZone<A, Z>

fn clone(&self) -> AddrAndZone<A, Z>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug, Z: Debug> Debug for AddrAndZone<A, Z>

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

Formats the value using the given formatter.

impl<A: Display, Z: Display> Display for AddrAndZone<A, Z>

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

Formats the value using the given formatter.

impl<A, Z> From<AddrAndZone<A, Z>> for ZonedAddr<A, Z>

fn from(a: AddrAndZone<A, Z>) -> Self

Converts to this type from the input type.

impl<A: SpecifiedAddress, Z> From<AddrAndZone<SpecifiedAddr<A>, Z>> for AddrAndZone<A, Z>

fn from(AddrAndZone: AddrAndZone<SpecifiedAddr<A>, Z>) -> Self

Converts to this type from the input type.

impl<A: GenericOverIp<I>, I: Ip, Z> GenericOverIp<I> for AddrAndZone<A, Z>

type Type = AddrAndZone<<A as GenericOverIp<I>>::Type, Z>

The type of Self when its IP-generic parameter is replaced with the type NewIp.

impl<A: Hash, Z: Hash> Hash for AddrAndZone<A, Z>

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<A: PartialEq, Z: PartialEq> PartialEq for AddrAndZone<A, Z>

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

impl<A: Eq, Z: Eq> Eq for AddrAndZone<A, Z>

impl<A, Z> StructuralPartialEq for AddrAndZone<A, Z>