Struct std::net::Ipv6Addr

1.0.0 · source · [−]

pub struct Ipv6Addr { /* private fields */ }

Expand description

An IPv6 address.

IPv6 addresses are defined as 128-bit integers in IETF RFC 4291. They are usually represented as eight 16-bit segments.

Embedding IPv4 Addresses

See IpAddr for a type encompassing both IPv4 and IPv6 addresses.

To assist in the transition from IPv4 to IPv6 two types of IPv6 addresses that embed an IPv4 address were defined: IPv4-compatible and IPv4-mapped addresses. Of these IPv4-compatible addresses have been officially deprecated.

Both types of addresses are not assigned any special meaning by this implementation, other than what the relevant standards prescribe. This means that an address like ::ffff:127.0.0.1, while representing an IPv4 loopback address, is not itself an IPv6 loopback address; only ::1 is. To handle these so called “IPv4-in-IPv6” addresses, they have to first be converted to their canonical IPv4 address.

IPv4-Compatible IPv6 Addresses

IPv4-compatible IPv6 addresses are defined in IETF RFC 4291 Section 2.5.5.1, and have been officially deprecated. The RFC describes the format of an “IPv4-Compatible IPv6 address” as follows:

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

So ::a.b.c.d would be an IPv4-compatible IPv6 address representing the IPv4 address a.b.c.d.

To convert from an IPv4 address to an IPv4-compatible IPv6 address, use Ipv4Addr::to_ipv6_compatible. Use Ipv6Addr::to_ipv4 to convert an IPv4-compatible IPv6 address to the canonical IPv4 address.

IPv4-Mapped IPv6 Addresses

IPv4-mapped IPv6 addresses are defined in IETF RFC 4291 Section 2.5.5.2. The RFC describes the format of an “IPv4-Mapped IPv6 address” as follows:

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

So ::ffff:a.b.c.d would be an IPv4-mapped IPv6 address representing the IPv4 address a.b.c.d.

To convert from an IPv4 address to an IPv4-mapped IPv6 address, use Ipv4Addr::to_ipv6_mapped. Use Ipv6Addr::to_ipv4 to convert an IPv4-mapped IPv6 address to the canonical IPv4 address. Note that this will also convert the IPv6 loopback address ::1 to 0.0.0.1. Use Ipv6Addr::to_ipv4_mapped to avoid this.

Textual representation

Ipv6Addr provides a FromStr implementation. There are many ways to represent an IPv6 address in text, but in general, each segments is written in hexadecimal notation, and segments are separated by :. For more information, see IETF RFC 5952.

Examples

use std::net::Ipv6Addr;

let localhost = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1);
assert_eq!("::1".parse(), Ok(localhost));
assert_eq!(localhost.is_loopback(), true);

Struct std::net::Ipv6Addr

Implementations

impl Ipv6Addr

pub const fn new( a: u16, b: u16, c: u16, d: u16, e: u16, f: u16, g: u16, h: u16) -> Ipv6Addr

pub const LOCALHOST: Self = _

pub const UNSPECIFIED: Self = _

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

pub const fn is_unspecified(&self) -> bool

pub const fn is_loopback(&self) -> bool

pub fn is_global(&self) -> bool

pub fn is_unique_local(&self) -> bool

pub fn is_unicast(&self) -> bool

pub fn is_unicast_link_local(&self) -> bool

pub fn is_documentation(&self) -> bool

pub const fn is_benchmarking(&self) -> bool

pub fn is_unicast_global(&self) -> bool

pub fn multicast_scope(&self) -> Option<Ipv6MulticastScope>

pub const fn is_multicast(&self) -> bool

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

pub const fn to_ipv4(&self) -> Option<Ipv4Addr>

pub fn to_canonical(&self) -> IpAddr

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

impl Ipv6Addr

pub fn parse_ascii(b: &[u8]) -> Result<Self, AddrParseError>

Trait Implementations

impl Clone for Ipv6Addr

fn clone(&self) -> Ipv6Addr

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

impl Debug for Ipv6Addr

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

impl Display for Ipv6Addr

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

impl From<[u16; 8]> for Ipv6Addr

fn from(segments: [u16; 8]) -> Ipv6Addr

impl From<[u8; 16]> for Ipv6Addr

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

impl From<Ipv6Addr> for IpAddr

fn from(ipv6: Ipv6Addr) -> IpAddr

impl From<Ipv6Addr> for u128

fn from(ip: Ipv6Addr) -> u128

impl From<u128> for Ipv6Addr

fn from(ip: u128) -> Ipv6Addr

impl FromStr for Ipv6Addr

type Err = AddrParseError

fn from_str(s: &str) -> Result<Ipv6Addr, AddrParseError>

impl Hash for Ipv6Addr

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

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

impl Ord for Ipv6Addr

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

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

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

const fn clamp(self, min: Self, max: Self) -> Selfwhere Self: PartialOrd<Self>,

impl PartialEq<IpAddr> for Ipv6Addr

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

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

impl PartialEq<Ipv6Addr> for IpAddr

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

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

impl PartialEq<Ipv6Addr> for Ipv6Addr

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

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

impl PartialOrd<IpAddr> for Ipv6Addr

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

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

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

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

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

impl PartialOrd<Ipv6Addr> for IpAddr

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

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

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

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

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

impl PartialOrd<Ipv6Addr> for Ipv6Addr

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

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

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

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

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

pub const fn new(
a: u16,
b: u16,
c: u16,
d: u16,
e: u16,
f: u16,
g: u16,
h: u16
) -> Ipv6Addr

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

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

const fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T> ToString for Twhere
T: Display + ?Sized,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,