Struct AddrSubnet

pub struct AddrSubnet<S: IpAddress, A: Witness<S> + Copy = SpecifiedAddr<S>> { /* private fields */ }

An address and that address’s subnet.

An AddrSubnet is a pair of an address and a subnet which maintains the invariant that the address is guaranteed to be a unicast address in the subnet. S is the type of address (Ipv4Addr or Ipv6Addr), and A is the type of the address in the subnet, which is always a witness wrapper around S. By default, it is SpecifiedAddr<S>.

Implementations

impl<S: IpAddress, A: Witness<S> + Copy> AddrSubnet<S, A>

pub fn new(addr: S, prefix: u8) -> Result<AddrSubnet<S, A>, AddrSubnetError>

Creates a new AddrSubnet.

new is like from_witness, except that it also converts addr into the appropriate witness type, returning AddrSubnetError::InvalidWitness if the conversion fails.

pub unsafe fn new_unchecked(addr: S, prefix: u8) -> Self

Creates a new AddrSubnet without checking for validity.

Safety

Unlike new, new_unchecked does not validate that prefix is in the proper range, and does not check that addr is a valid value for the witness type A. It is up to the caller to guarantee that prefix is in the proper range, and A::new(addr) is not None.

pub fn from_witness( addr: A, prefix: u8, ) -> Result<AddrSubnet<S, A>, AddrSubnetError>

Creates a new AddrSubnet from an existing witness.

from_witness creates a new AddrSubnet with the given address and prefix length. The network address of the subnet is taken to be the first prefix bits of the address. It returns Err if prefix is longer than the number of bits in this type of IP address (32 for IPv4 and 128 for IPv6) or if addr is not a unicast address in the resulting subnet (see IpAddress::is_unicast_in_subnet).

pub fn subnet(&self) -> Subnet<S>

Gets the subnet.

pub fn addr(&self) -> A

Gets the address.

pub fn addr_subnet(self) -> (A, Subnet<S>)

Gets the address and subnet.

pub fn to_witness<B: Witness<S> + Copy>(&self) -> AddrSubnet<S, B>

where A: Into<B>,

Constructs a new AddrSubnet of a different witness type.

pub fn add_witness<B: Witness<A> + Witness<S> + Copy>( &self, ) -> Option<AddrSubnet<S, B>>

Wraps an additional witness onto this AddrSubnet.

pub fn replace_witness<B: Witness<S> + Copy>(&self) -> Option<AddrSubnet<S, B>>

Replaces the AddrSubnet witness.

impl<A: Witness<Ipv6Addr> + Copy> AddrSubnet<Ipv6Addr, A>

pub fn ipv6_unicast_addr(&self) -> UnicastAddr<Ipv6Addr>

Gets the address as a UnicastAddr witness.

Since one of the invariants on an AddrSubnet is that its contained address is unicast in its subnet, ipv6_unicast_addr can infallibly convert its stored address to a UnicastAddr.

pub fn to_unicast(&self) -> AddrSubnet<Ipv6Addr, UnicastAddr<Ipv6Addr>>

Constructs a new AddrSubnet which stores a UnicastAddr witness.

Since one of the invariants on an AddrSubnet is that its contained address is unicast in its subnet, to_unicast can infallibly convert its stored address to a UnicastAddr.

Trait Implementations

impl<S: Clone + IpAddress, A: Clone + Witness<S> + Copy> Clone for AddrSubnet<S, A>

fn clone(&self) -> AddrSubnet<S, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + IpAddress, A: Debug + Witness<S> + Copy> Debug for AddrSubnet<S, A>

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

Formats the value using the given formatter.

impl<S: IpAddress, A: Witness<S> + Copy + Display> Display for AddrSubnet<S, A>

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

Formats the value using the given formatter.

impl<S: IpAddress, A: IpAddressWitness<S> + Copy> From<AddrSubnet<S, A>> for AddrSubnetEither<A::IpAddrWitness>

fn from(addr_sub: AddrSubnet<S, A>) -> AddrSubnetEither<A::IpAddrWitness>

Converts to this type from the input type.

impl<S: Hash + IpAddress, A: Hash + Witness<S> + Copy> Hash for AddrSubnet<S, A>

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<S: PartialEq + IpAddress, A: PartialEq + Witness<S> + Copy> PartialEq for AddrSubnet<S, A>

fn eq(&self, other: &AddrSubnet<S, A>) -> 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<S: Copy + IpAddress, A: Copy + Witness<S> + Copy> Copy for AddrSubnet<S, A>

impl<S: Eq + IpAddress, A: Eq + Witness<S> + Copy> Eq for AddrSubnet<S, A>

impl<S: IpAddress, A: Witness<S> + Copy> StructuralPartialEq for AddrSubnet<S, A>