Enum UnicastOrMulticastIpv6Addr

pub enum UnicastOrMulticastIpv6Addr {
    Unicast(UnicastAddr<Ipv6Addr>),
    Multicast(MulticastAddr<Ipv6Addr>),
}

An IPv6 address stored as a unicast or multicast witness type.

UnicastOrMulticastIpv6Addr is either a UnicastAddr or a MulticastAddr. It allows the user to match on the unicast-ness or multicast-ness of an IPv6 address and obtain a statically-typed witness in each case. This is useful if the user needs to call different functions which each take a witness type.

Variants

Unicast(UnicastAddr<Ipv6Addr>)

Multicast(MulticastAddr<Ipv6Addr>)

Implementations

impl UnicastOrMulticastIpv6Addr

pub fn new(addr: Ipv6Addr) -> Option<UnicastOrMulticastIpv6Addr>

Constructs a new UnicastOrMulticastIpv6Addr.

Returns None if addr is the unspecified address.

pub fn from_specified( addr: SpecifiedAddr<Ipv6Addr>, ) -> UnicastOrMulticastIpv6Addr

Constructs a new UnicastOrMulticastIpv6Addr from a specified address.

Methods from Deref<Target = Ipv6Addr>

pub fn ipv6_bytes(&self) -> [u8; 16]

Gets the bytes of the IPv6 address.

pub fn segments(&self) -> [u16; 8]

Gets the 16-bit segments of the IPv6 address.

pub fn to_solicited_node_address(&self) -> MulticastAddr<Ipv6Addr>

Converts this Ipv6Addr to the IPv6 Solicited-Node Address, used in Neighbor Discovery, defined in RFC 4291 Section 2.7.1.

pub fn is_valid_unicast(&self) -> bool

Is this a valid unicast address?

A valid unicast address is any unicast address that can be bound to an interface (not the unspecified or loopback addresses). addr.is_valid_unicast() is equivalent to !(addr.is_loopback() || !addr.is_specified() || addr.is_multicast()).

pub fn is_site_local(&self) -> bool

Is this address in the (deprecated) site-local unicast subnet?

is_site_local returns true if self is in the (deprecated) Ipv6::SITE_LOCAL_UNICAST_SUBNET. See that constant’s documentation for more details on deprecation and how the subnet should be used in light of deprecation.

pub fn is_unicast_link_local(&self) -> bool

Is this a unicast link-local address?

addr.is_unicast_link_local() is equivalent to addr.is_unicast_in_subnet(&Ipv6::LINK_LOCAL_UNICAST_SUBNET).

pub fn to_ipv4_compatible(&self) -> Option<Ipv4Addr>

Tries to extract the IPv4 address from an IPv4-compatible IPv6 address.

IPv4-compatible IPv6 addresses were defined to assist in the IPv6 transition, and are now specified in RFC 4291 Section 2.5.5.1. The lowest-order 32 bits carry an IPv4 address, while the highest-order 96 bits are all set to 0 as in this diagram from the RFC:

|                80 bits               | 16 |      32 bits        |
+--------------------------------------+--------------------------+
|0000..............................0000|0000|    IPv4 address     |
+--------------------------------------+----+---------------------+

to_ipv4_compatible checks to see if self is an IPv4-compatible IPv6 address. If it is, the IPv4 address is extracted and returned.

Per RFC 4291:

The ‘IPv4-Compatible IPv6 address’ is now deprecated because the current IPv6 transition mechanisms no longer use these addresses. New or updated implementations are not required to support this address type.

The more modern embedding format is IPv4-mapped IPv6 addressing - see to_ipv4_mapped.

pub fn to_ipv4_mapped(&self) -> Option<Ipv4Addr>

Tries to extract the IPv4 address from an IPv4-mapped IPv6 address.

IPv4-mapped IPv6 addresses are used to represent the addresses of IPv4 nodes as IPv6 addresses, and are defined in RFC 4291 Section 2.5.5.2. The lowest-order 32 bits carry an IPv4 address, the middle order 16 bits carry the literal 0xFFFF, and the highest order 80 bits are set to 0 as in this diagram from the RFC:

|                80 bits               | 16 |      32 bits        |
+--------------------------------------+--------------------------+
|0000..............................0000|FFFF|    IPv4 address     |
+--------------------------------------+----+---------------------+

to_ipv4_mapped checks to see if self is an IPv4-mapped IPv6 address. If it is, the IPv4 address is extracted and returned.

Trait Implementations

impl AsRef<Ipv6Addr> for UnicastOrMulticastIpv6Addr

fn as_ref(&self) -> &Ipv6Addr

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

impl Clone for UnicastOrMulticastIpv6Addr

fn clone(&self) -> UnicastOrMulticastIpv6Addr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnicastOrMulticastIpv6Addr

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

Formats the value using the given formatter.

impl Deref for UnicastOrMulticastIpv6Addr

type Target = Ipv6Addr

The resulting type after dereferencing.

fn deref(&self) -> &Ipv6Addr

Dereferences the value.

impl Display for UnicastOrMulticastIpv6Addr

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

Formats the value using the given formatter.

impl From<&UnicastOrMulticastIpv6Addr> for Ipv6Addr

fn from(addr: &UnicastOrMulticastIpv6Addr) -> Ipv6Addr

Converts to this type from the input type.

impl From<MulticastAddr<Ipv6Addr>> for UnicastOrMulticastIpv6Addr

fn from(addr: MulticastAddr<Ipv6Addr>) -> UnicastOrMulticastIpv6Addr

Converts to this type from the input type.

impl From<UnicastAddr<Ipv6Addr>> for UnicastOrMulticastIpv6Addr

fn from(addr: UnicastAddr<Ipv6Addr>) -> UnicastOrMulticastIpv6Addr

Converts to this type from the input type.

impl From<UnicastOrMulticastIpv6Addr> for Ipv6Addr

fn from(addr: UnicastOrMulticastIpv6Addr) -> Ipv6Addr

Converts to this type from the input type.

impl LinkLocalAddress for UnicastOrMulticastIpv6Addr

fn is_link_local(&self) -> bool

Is this a link-local address?

impl MappedAddress for UnicastOrMulticastIpv6Addr

fn is_non_mapped(&self) -> bool

Is this a non-mapped address?

impl MulticastAddress for UnicastOrMulticastIpv6Addr

fn is_multicast(&self) -> bool

Is this a multicast address?

fn is_non_multicast(&self) -> bool

Is this a non-multicast address? The inverse of is_multicast().

impl PartialEq for UnicastOrMulticastIpv6Addr

fn eq(&self, other: &UnicastOrMulticastIpv6Addr) -> 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 TryFrom<Ipv6Addr> for UnicastOrMulticastIpv6Addr

type Error = ()

The type returned in the event of a conversion error.

fn try_from(addr: Ipv6Addr) -> Result<UnicastOrMulticastIpv6Addr, ()>

Performs the conversion.

impl UnicastAddress for UnicastOrMulticastIpv6Addr

fn is_unicast(&self) -> bool

Is this a unicast address?

impl Witness<Ipv6Addr> for UnicastOrMulticastIpv6Addr

fn new(addr: Ipv6Addr) -> Option<UnicastOrMulticastIpv6Addr>

Constructs a new witness type.

unsafe fn new_unchecked(addr: Ipv6Addr) -> UnicastOrMulticastIpv6Addr

Constructs a new witness type without checking to see if addr actually satisfies the required property.

fn into_addr(self) -> Ipv6Addr

Consumes this witness and returns the contained A.

fn from_witness<W: Witness<A>>(addr: W) -> Option<Self>

Constructs a new witness type from an existing witness type.

fn get(&self) -> A

where A: Copy,

Gets a copy of the address.

impl Copy for UnicastOrMulticastIpv6Addr

impl Eq for UnicastOrMulticastIpv6Addr

impl StructuralPartialEq for UnicastOrMulticastIpv6Addr