Struct Ipv6Addr

pub struct Ipv6Addr(/* private fields */);

An IPv6 address.

Layout

Ipv6Addr has the same layout as [u8; 16], which is the layout that most protocols use to represent an IPv6 address in their packet formats. This can be useful when parsing an IPv6 address from a packet. For example:

/// The fixed part of an IPv6 packet header.
///
/// `FixedHeader` has the same layout as the fixed part of an IPv6 packet
/// header.
#[repr(C)]
pub struct FixedHeader {
    version_tc_flowlabel: [u8; 4],
    payload_len: [u8; 2],
    next_hdr: u8,
    hop_limit: u8,
    src_ip: Ipv6Addr,
    dst_ip: Ipv6Addr,
}

Display

The Display impl for Ipv6Addr formats according to RFC 5952.

Where RFC 5952 leaves decisions up to the implementation, Ipv6Addr matches the behavior of std::net::Ipv6Addr - all IPv6 addresses are formatted the same by Ipv6Addr as by <std::net::Ipv6Addr as Display>::fmt.

Implementations

impl Ipv6Addr

pub const fn new(segments: [u16; 8]) -> Ipv6Addr

Creates a new IPv6 address from 16-bit segments.

pub const fn from_bytes(bytes: [u8; 16]) -> Ipv6Addr

Creates a new IPv6 address from bytes.

pub const 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 const 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 Ipv6SourceAddr

fn as_ref(&self) -> &Ipv6Addr

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

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 Ipv6Addr

fn clone(&self) -> Ipv6Addr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ipv6Addr

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

Formats the value using the given formatter.

impl Default for Ipv6Addr

fn default() -> Ipv6Addr

Returns the “default value” for a type.

impl Display for Ipv6Addr

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

Formats an IPv6 address according to RFC 5952.

Where RFC 5952 leaves decisions up to the implementation, this function matches the behavior of std::net::Ipv6Addr - all IPv6 addresses are formatted the same by this function as by <std::net::Ipv6Addr as Display>::fmt.

impl From<&Ipv6SourceAddr> for Ipv6Addr

fn from(addr: &Ipv6SourceAddr) -> Ipv6Addr

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 From<[u8; 16]> for Ipv6Addr

fn from(bytes: [u8; 16]) -> Ipv6Addr

Converts to this type from the input type.

impl From<Ipv4Addr> for Ipv6Addr

Ipv4Addr is convertible into Ipv6Addr through Ipv4Addr::to_ipv6_mapped.

fn from(addr: Ipv4Addr) -> Ipv6Addr

Converts to this type from the input type.

impl From<Ipv6Addr> for Ipv6Addr

fn from(addr: Ipv6Addr) -> Ipv6Addr

Converts to this type from the input type.

impl From<Ipv6Addr> for Ipv6Addr

fn from(addr: Ipv6Addr) -> Ipv6Addr

Converts to this type from the input type.

impl From<Ipv6SourceAddr> for Ipv6Addr

fn from(addr: Ipv6SourceAddr) -> Ipv6Addr

Converts to this type from the input type.

impl<A: Into<Ipv6Addr> + LinkLocalAddress + Copy> From<LinkLocalAddr<A>> for Ipv6Addr

fn from(addr: LinkLocalAddr<A>) -> Ipv6Addr

Converts to this type from the input type.

impl<A: Into<Ipv6Addr> + MulticastAddress + Copy> From<MulticastAddr<A>> for Ipv6Addr

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

Converts to this type from the input type.

impl<A: Into<Ipv6Addr> + MappedAddress + Copy> From<NonMappedAddr<A>> for Ipv6Addr

fn from(addr: NonMappedAddr<A>) -> Ipv6Addr

Converts to this type from the input type.

impl<A: Into<Ipv6Addr> + SpecifiedAddress + Copy> From<SpecifiedAddr<A>> for Ipv6Addr

fn from(addr: SpecifiedAddr<A>) -> Ipv6Addr

Converts to this type from the input type.

impl<A: Into<Ipv6Addr> + UnicastAddress + Copy> From<UnicastAddr<A>> for Ipv6Addr

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

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 FromBytes for Ipv6Addr

where [u8; 16]: FromBytes,

fn ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the prefix of the given source as a &Self without copying.

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: Immutable + KnownLayout,

Interprets the suffix of the given bytes as a &Self.

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromZeros for Ipv6Addr

where [u8; 16]: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl<I: Ip> GenericOverIp<I> for Ipv6Addr

type Type = <I as Ip>::Addr

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

impl Hash for Ipv6Addr

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 IntoBytes for Ipv6Addr

where [u8; 16]: IntoBytes,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl IpAddress for Ipv6Addr

const BYTES: u8 = 16u8

The number of bytes in an address of this type.

type Version = Ipv6

The IP version type of this address.

fn mask(&self, bits: u8) -> Ipv6Addr

Masks off the top bits of the address.

fn bytes(&self) -> &[u8]

Gets the underlying bytes of the address.

fn to_ip_addr(&self) -> IpAddr

Converts a statically-typed IP address into a dynamically-typed one.

fn common_prefix_len(&self, other: &Ipv6Addr) -> u8

Calculates the common prefix length between this address and other.

fn is_unicast_in_subnet(&self, subnet: &Subnet<Self>) -> bool

Is this a unicast address contained in the given subnet?

fn is_loopback(&self) -> bool

Is this a loopback address?

impl KnownLayout for Ipv6Addr

where Self: Sized,

type PointerMetadata = ()

The type of metadata stored in a pointer to Self.

impl LinkLocalAddress for Ipv6Addr

fn is_link_local(&self) -> bool

Is this address in the link-local subnet?

is_link_local returns true if self is in Ipv6::LINK_LOCAL_UNICAST_SUBNET, is a multicast address whose scope is link-local, or is the address Ipv6::LOOPBACK_ADDRESS (per RFC 4291 Section 2.5.3, the loopback address is considered to have link-local scope).

impl Ord for Ipv6Addr

fn cmp(&self, other: &Ipv6Addr) -> 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 Ipv6Addr

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

fn partial_cmp(&self, other: &Ipv6Addr) -> 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 ScopeableAddress for Ipv6Addr

fn scope(&self) -> Ipv6Scope

The scope of this address.

type Scope = Ipv6Scope

The type of all non-global scopes.

impl TryFrom<Ipv6Addr> for Ipv6SourceAddr

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Ipv6Addr> for LinkLocalAddr<Ipv6Addr>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Ipv6Addr> for MulticastAddr<Ipv6Addr>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Ipv6Addr> for NonMappedAddr<Ipv6Addr>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Ipv6Addr> for SpecifiedAddr<Ipv6Addr>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Ipv6Addr> for UnicastAddr<Ipv6Addr>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

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 TryFromBytes for Ipv6Addr

where [u8; 16]: TryFromBytes,

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl UnicastAddress for Ipv6Addr

fn is_unicast(&self) -> bool

Is this a unicast address?

addr.is_unicast() is equivalent to !addr.is_multicast() && addr.is_specified().

impl Witness<Ipv6Addr> for Ipv6SourceAddr

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

Constructs a new witness type.

unsafe fn new_unchecked(addr: Ipv6Addr) -> Ipv6SourceAddr

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 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 Ipv6Addr

impl Eq for Ipv6Addr

impl Immutable for Ipv6Addr

where [u8; 16]: Immutable,

impl StructuralPartialEq for Ipv6Addr

impl Unaligned for Ipv6Addr

where [u8; 16]: Unaligned,