Ipv6Addr in core::net - Rust
Description: An IPv6 address.

# Struct Ipv6Addr

1.77.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);

## Implementations§

Source§

### impl Ipv6Addr

1.80.0 · Source

#### pub const BITS: u32 = 128u32

The size of an IPv6 address in bits.

##### §Examples

    use std::net::Ipv6Addr;

    assert_eq!(Ipv6Addr::BITS, 128);

1.30.0 · Source

#### pub const LOCALHOST: Self

An IPv6 address representing localhost: `::1`.

This corresponds to constant `IN6ADDR_LOOPBACK_INIT` or `in6addr_loopback` in other languages.

##### §Examples

    use std::net::Ipv6Addr;

    let addr = Ipv6Addr::LOCALHOST;
    assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));

1.30.0 · Source

#### pub const UNSPECIFIED: Self

An IPv6 address representing the unspecified address: `::`.

This corresponds to constant `IN6ADDR_ANY_INIT` or `in6addr_any` in other languages.

##### §Examples

    use std::net::Ipv6Addr;

    let addr = Ipv6Addr::UNSPECIFIED;
    assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));

1.0.0 (const: 1.32.0) · Source

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

Creates a new IPv6 address from eight 16-bit segments.

The result will represent the IP address `a:b:c:d:e:f:g:h`.

##### §Examples

    use std::net::Ipv6Addr;

    let addr = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff);

1.80.0 (const: 1.80.0) · Source

#### pub const fn to_bits(self) -> u128

Converts an IPv6 address into a `u128` representation using native byte order.

Although IPv6 addresses are big-endian, the `u128` value will use the target platform’s native byte order. That is, the `u128` value is an integer representation of the IPv6 address and not an integer interpretation of the IPv6 address’s big-endian bitstring. This means that the `u128` value masked with `0xffffffffffffffffffffffffffff0000_u128` will set the last segment in the address to 0, regardless of the target platform’s endianness.

##### §Examples

    use std::net::Ipv6Addr;

    let addr = Ipv6Addr::new(
        0x1020, 0x3040, 0x5060, 0x7080,
        0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
    );
    assert_eq!(0x102030405060708090A0B0C0D0E0F00D_u128, addr.to_bits());

    use std::net::Ipv6Addr;

    let addr = Ipv6Addr::new(
        0x1020, 0x3040, 0x5060, 0x7080,
        0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
    );
    let addr_bits = addr.to_bits() & 0xffffffffffffffffffffffffffff0000_u128;
    assert_eq!(
        Ipv6Addr::new(
            0x1020, 0x3040, 0x5060, 0x7080,
            0x90A0, 0xB0C0, 0xD0E0, 0x0000,
        ),
        Ipv6Addr::from_bits(addr_bits));

1.80.0 (const: 1.80.0) · Source

#### pub const fn from_bits(bits: u128) -> Ipv6Addr

Converts a native byte order `u128` into an IPv6 address.

See `Ipv6Addr::to_bits` for an explanation on endianness.

##### §Examples

    use std::net::Ipv6Addr;

    let addr = Ipv6Addr::from_bits(0x102030405060708090A0B0C0D0E0F00D_u128);
    assert_eq!(
        Ipv6Addr::new(
            0x1020, 0x3040, 0x5060, 0x7080,
            0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
        ),
        addr);

1.0.0 (const: 1.50.0) · Source

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

Returns the eight 16-bit segments that make up this address.

##### §Examples

    use std::net::Ipv6Addr;

    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).segments(),
               [0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff]);

Source

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

🔬This is a nightly-only experimental API. (`ip_from` #131360)

Creates an `Ipv6Addr` from an eight element 16-bit array.

##### §Examples

    #![feature(ip_from)]
    use std::net::Ipv6Addr;

    let addr = Ipv6Addr::from_segments([
        0x20du16, 0x20cu16, 0x20bu16, 0x20au16,
        0x209u16, 0x208u16, 0x207u16, 0x206u16,
    ]);
    assert_eq!(
        Ipv6Addr::new(
            0x20d, 0x20c, 0x20b, 0x20a,
            0x209, 0x208, 0x207, 0x206,
        ),
        addr
    );

1.7.0 (const: 1.50.0) · Source

#### pub const fn is_unspecified(&self) -> bool

Returns `true` for the special ‘unspecified’ address (`::`).

This property is defined in IETF RFC 4291.

##### §Examples

    use std::net::Ipv6Addr;

    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unspecified(), false);
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).is_unspecified(), true);

1.7.0 (const: 1.50.0) · Source

#### pub const fn is_loopback(&self) -> bool

Returns `true` if this is the loopback address (`::1`), as defined in IETF RFC 4291 section 2.5.3.

Contrary to IPv4, in IPv6 there is only one loopback address.

##### §Examples

    use std::net::Ipv6Addr;

    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_loopback(), false);
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_loopback(), true);

Source

#### pub const fn is_global(&self) -> bool

🔬This is a nightly-only experimental API. (`ip` #27709)

Returns `true` if the address appears to be globally reachable as specified by the IANA IPv6 Special-Purpose Address Registry.

Whether or not an address is practically reachable will depend on your network configuration. Most IPv6 addresses are globally reachable, unless they are specifically defined as not globally reachable.

Non-exhaustive list of notable addresses that are not globally reachable:

- The unspecified address (`is_unspecified`)
- The loopback address (`is_loopback`)
- IPv4-mapped addresses
- Addresses reserved for benchmarking (`is_benchmarking`)
- Addresses reserved for documentation (`is_documentation`)
- Unique local addresses (`is_unique_local`)
- Unicast addresses with link-local scope (`is_unicast_link_local`)

For the complete overview of which addresses are globally reachable, see the table at the IANA IPv6 Special-Purpose Address Registry.

Note that an address having global scope is not the same as being globally reachable, and there is no direct relation between the two concepts: There exist addresses with global scope that are not globally reachable (for example unique local addresses), and addresses that are globally reachable without having global scope (multicast addresses with non-global scope).

##### §Examples

    #![feature(ip)]

    use std::net::Ipv6Addr;

    // Most IPv6 addresses are globally reachable:
    assert_eq!(Ipv6Addr::new(0x26, 0, 0x1c9, 0, 0, 0xafc8, 0x10, 0x1).is_global(), true);

    // However some addresses have been assigned a special meaning
    // that makes them not globally reachable. Some examples are:

    // The unspecified address (`::`)
    assert_eq!(Ipv6Addr::UNSPECIFIED.is_global(), false);

    // The loopback address (`::1`)
    assert_eq!(Ipv6Addr::LOCALHOST.is_global(), false);

    // IPv4-mapped addresses (`::ffff:0:0/96`)
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_global(), false);

    // Addresses reserved for benchmarking (`2001:2::/48`)
    assert_eq!(Ipv6Addr::new(0x2001, 2, 0, 0, 0, 0, 0, 1,).is_global(), false);

    // Addresses reserved for documentation (`2001:db8::/32` and `3fff::/20`)
    assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1).is_global(), false);
    assert_eq!(Ipv6Addr::new(0x3fff, 0, 0, 0, 0, 0, 0, 0).is_global(), false);

    // Unique local addresses (`fc00::/7`)
    assert_eq!(Ipv6Addr::new(0xfc02, 0, 0, 0, 0, 0, 0, 1).is_global(), false);

    // Unicast addresses with link-local scope (`fe80::/10`)
    assert_eq!(Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 1).is_global(), false);

    // For a complete overview see the IANA IPv6 Special-Purpose Address Registry.

1.84.0 (const: 1.84.0) · Source

#### pub const fn is_unique_local(&self) -> bool

Returns `true` if this is a unique local address (`fc00::/7`).

This property is defined in IETF RFC 4193.

##### §Examples

    use std::net::Ipv6Addr;

    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unique_local(), false);
    assert_eq!(Ipv6Addr::new(0xfc02, 0, 0, 0, 0, 0, 0, 0).is_unique_local(), true);

Source

#### pub const fn is_unicast(&self) -> bool

🔬This is a nightly-only experimental API. (`ip` #27709)

Returns `true` if this is a unicast address, as defined by IETF RFC 4291. Any address that is not a multicast address (`ff00::/8`) is unicast.

##### §Examples

    #![feature(ip)]

    use std::net::Ipv6Addr;

    // The unspecified and loopback addresses are unicast.
    assert_eq!(Ipv6Addr::UNSPECIFIED.is_unicast(), true);
    assert_eq!(Ipv6Addr::LOCALHOST.is_unicast(), true);

    // Any address that is not a multicast address (`ff00::/8`) is unicast.
    assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_unicast(), true);
    assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).is_unicast(), false);

1.84.0 (const: 1.84.0) · Source

#### pub const fn is_unicast_link_local(&self) -> bool

Returns `true` if the address is a unicast address with link-local scope, as defined in RFC 4291.

A unicast address has link-local scope if it has the prefix `fe80::/10`, as per RFC 4291 section 2.4. Note that this encompasses more addresses than those defined in RFC 4291 section 2.5.6, which describes “Link-Local IPv6 Unicast Addresses” as having the following stricter format:

    | 10 bits  |         54 bits         |          64 bits           |
    +----------+-------------------------+----------------------------+
    |1111111010|           0             |       interface ID         |
    +----------+-------------------------+----------------------------+

So while currently the only addresses with link-local scope an application will encounter are all in `fe80::/64`, this might change in the future with the publication of new standards. More addresses in `fe80::/10` could be allocated, and those addresses will have link-local scope.

Also note that while RFC 4291 section 2.5.3 mentions about the loopback address (`::1`) that “it is treated as having Link-Local scope”, this does not mean that the loopback address actually has link-local scope and this method will return `false` on it.

##### §Examples

    use std::net::Ipv6Addr;

    // The loopback address (`::1`) does not actually have link-local scope.
    assert_eq!(Ipv6Addr::LOCALHOST.is_unicast_link_local(), false);

    // Only addresses in `fe80::/10` have link-local scope.
    assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_unicast_link_local(), false);
    assert_eq!(Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 0).is_unicast_link_local(), true);

    // Addresses outside the stricter `fe80::/64` also have link-local scope.
    assert_eq!(Ipv6Addr::new(0xfe80, 0, 0, 1, 0, 0, 0, 0).is_unicast_link_local(), true);
    assert_eq!(Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 0).is_unicast_link_local(), true);

Source

#### pub const fn is_documentation(&self) -> bool

🔬This is a nightly-only experimental API. (`ip` #27709)

Returns `true` if this is an address reserved for documentation (`2001:db8::/32` and `3fff::/20`).

This property is defined by IETF RFC 3849 and IETF RFC 9637.

##### §Examples

    #![feature(ip)]

    use std::net::Ipv6Addr;

    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_documentation(), false);
    assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_documentation(), true);
    assert_eq!(Ipv6Addr::new(0x3fff, 0, 0, 0, 0, 0, 0, 0).is_documentation(), true);

Source

#### pub const fn is_benchmarking(&self) -> bool

🔬This is a nightly-only experimental API. (`ip` #27709)

Returns `true` if this is an address reserved for benchmarking (`2001:2::/48`).

This property is defined in IETF RFC 5180, where it is mistakenly specified as covering the range `2001:0200::/48`. This is corrected in IETF RFC Errata 1752 to `2001:0002::/48`.

    #![feature(ip)]

    use std::net::Ipv6Addr;

    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc613, 0x0).is_benchmarking(), false);
    assert_eq!(Ipv6Addr::new(0x2001, 0x2, 0, 0, 0, 0, 0, 0).is_benchmarking(), true);

Source

#### pub const fn is_unicast_global(&self) -> bool

🔬This is a nightly-only experimental API. (`ip` #27709)

Returns `true` if the address is a globally routable unicast address.

The following return false:

- the loopback address
- the link-local addresses
- unique local addresses
- the unspecified address
- the address range reserved for documentation

This method returns `true` for site-local addresses as per RFC 4291 section 2.5.7

    The special behavior of [the site-local unicast] prefix defined in [RFC3513] must no longer
    be supported in new implementations (i.e., new implementations must treat this prefix as
    Global Unicast).

##### §Examples

    #![feature(ip)]

    use std::net::Ipv6Addr;

    assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_unicast_global(), false);
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_global(), true);

Source

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

🔬This is a nightly-only experimental API. (`ip` #27709)

Returns the address’s multicast scope if the address is multicast.

##### §Examples

    #![feature(ip)]

    use std::net::{Ipv6Addr, Ipv6MulticastScope};

    assert_eq!(
        Ipv6Addr::new(0xff0e, 0, 0, 0, 0, 0, 0, 0).multicast_scope(),
        Some(Ipv6MulticastScope::Global)
    );
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).multicast_scope(), None);

1.7.0 (const: 1.50.0) · Source

#### pub const fn is_multicast(&self) -> bool

Returns `true` if this is a multicast address (`ff00::/8`).

This property is defined by IETF RFC 4291.

##### §Examples

    use std::net::Ipv6Addr;

    assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).is_multicast(), true);
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_multicast(), false);

Source

#### pub const fn is_ipv4_mapped(&self) -> bool

🔬This is a nightly-only experimental API. (`ip` #27709)

Returns `true` if the address is an IPv4-mapped address (`::ffff:0:0/96`).

IPv4-mapped addresses can be converted to their canonical IPv4 address with `to_ipv4_mapped`.

##### §Examples

    #![feature(ip)]

    use std::net::{Ipv4Addr, Ipv6Addr};

    let ipv4_mapped = Ipv4Addr::new(192, 0, 2, 255).to_ipv6_mapped();
    assert_eq!(ipv4_mapped.is_ipv4_mapped(), true);
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc000, 0x2ff).is_ipv4_mapped(), true);

    assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_ipv4_mapped(), false);

1.63.0 (const: 1.75.0) · Source

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

Converts this address to an `IPv4` address if it’s an IPv4-mapped address, as defined in IETF RFC 4291 section 2.5.5.2, otherwise returns `None`.

`::ffff:a.b.c.d` becomes `a.b.c.d`. All addresses not starting with `::ffff` will return `None`.

##### §Examples

    use std::net::{Ipv4Addr, Ipv6Addr};

    assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).to_ipv4_mapped(), None);
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).to_ipv4_mapped(),
               Some(Ipv4Addr::new(192, 10, 2, 255)));
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_ipv4_mapped(), None);

1.0.0 (const: 1.50.0) · Source

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

Converts this address to an `IPv4` address if it is either an IPv4-compatible address as defined in IETF RFC 4291 section 2.5.5.1, or an IPv4-mapped address as defined in IETF RFC 4291 section 2.5.5.2, otherwise returns `None`.

Note that this will return an `IPv4` address for the IPv6 loopback address `::1`. Use `Ipv6Addr::to_ipv4_mapped` to avoid this.

`::a.b.c.d` and `::ffff:a.b.c.d` become `a.b.c.d`. `::1` becomes `0.0.0.1`. All addresses not starting with either all zeroes or `::ffff` will return `None`.

##### §Examples

    use std::net::{Ipv4Addr, Ipv6Addr};

    assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).to_ipv4(), None);
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).to_ipv4(),
               Some(Ipv4Addr::new(192, 10, 2, 255)));
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_ipv4(),
               Some(Ipv4Addr::new(0, 0, 0, 1)));

1.75.0 (const: 1.75.0) · Source

#### pub const fn to_canonical(&self) -> IpAddr

Converts this address to an `IpAddr::V4` if it is an IPv4-mapped address, otherwise returns self wrapped in an `IpAddr::V6`.

##### §Examples

    use std::net::Ipv6Addr;

    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x7f00, 0x1).is_loopback(), false);
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x7f00, 0x1).to_canonical().is_loopback(), true);

1.12.0 (const: 1.32.0) · Source

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

Returns the sixteen eight-bit integers the IPv6 address consists of.

    use std::net::Ipv6Addr;

    assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).octets(),
               [0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);

Source

#### pub const fn from_octets(octets: [u8; 16]) -> Ipv6Addr

🔬This is a nightly-only experimental API. (`ip_from` #131360)

Creates an `Ipv6Addr` from a sixteen element byte array.

##### §Examples

    #![feature(ip_from)]
    use std::net::Ipv6Addr;

    let addr = Ipv6Addr::from_octets([
        0x19u8, 0x18u8, 0x17u8, 0x16u8, 0x15u8, 0x14u8, 0x13u8, 0x12u8,
        0x11u8, 0x10u8, 0x0fu8, 0x0eu8, 0x0du8, 0x0cu8, 0x0bu8, 0x0au8,
    ]);
    assert_eq!(
        Ipv6Addr::new(
            0x1918, 0x1716, 0x1514, 0x1312,
            0x1110, 0x0f0e, 0x0d0c, 0x0b0a,
        ),
        addr
    );

Source

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

🔬This is a nightly-only experimental API. (`ip_as_octets` #137259)

Returns the sixteen eight-bit integers the IPv6 address consists of as a slice.

##### §Examples

    #![feature(ip_as_octets)]

    use std::net::Ipv6Addr;

    assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).as_octets(),
               &[255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0])

Source§

### impl Ipv6Addr

Source

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

🔬This is a nightly-only experimental API. (`addr_parse_ascii` #101035)

Parse an IPv6 address from a slice of bytes.

    #![feature(addr_parse_ascii)]

    use std::net::Ipv6Addr;

    let localhost = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1);

    assert_eq!(Ipv6Addr::parse_ascii(b"::1"), Ok(localhost));

## Trait Implementations§

1.75.0 · Source§

### impl BitAnd<&Ipv6Addr> for &Ipv6Addr

Source§

#### type Output = Ipv6Addr

The resulting type after applying the `&` operator.
Source§

#### fn bitand(self, rhs: &Ipv6Addr) -> Ipv6Addr

Performs the `&` operation. Read more
1.75.0 · Source§

### impl BitAnd<&Ipv6Addr> for Ipv6Addr

Source§

#### type Output = Ipv6Addr

The resulting type after applying the `&` operator.
Source§

#### fn bitand(self, rhs: &Ipv6Addr) -> Ipv6Addr

Performs the `&` operation. Read more
1.75.0 · Source§

### impl BitAnd<Ipv6Addr> for &Ipv6Addr

Source§

#### type Output = Ipv6Addr

The resulting type after applying the `&` operator.
Source§

#### fn bitand(self, rhs: Ipv6Addr) -> Ipv6Addr

Performs the `&` operation. Read more
1.75.0 · Source§

### impl BitAnd for Ipv6Addr

Source§

#### type Output = Ipv6Addr

The resulting type after applying the `&` operator.
Source§

#### fn bitand(self, rhs: Ipv6Addr) -> Ipv6Addr

Performs the `&` operation. Read more
1.75.0 · Source§

### impl BitAndAssign<&Ipv6Addr> for Ipv6Addr

Source§

#### fn bitand_assign(&mut self, rhs: &Ipv6Addr)

Performs the `&=` operation. Read more
1.75.0 · Source§

### impl BitAndAssign for Ipv6Addr

Source§

#### fn bitand_assign(&mut self, rhs: Ipv6Addr)

Performs the `&=` operation. Read more
1.75.0 · Source§

### impl BitOr<&Ipv6Addr> for &Ipv6Addr

Source§

#### type Output = Ipv6Addr

The resulting type after applying the `|` operator.
Source§

#### fn bitor(self, rhs: &Ipv6Addr) -> Ipv6Addr

Performs the `|` operation. Read more
1.75.0 · Source§

### impl BitOr<&Ipv6Addr> for Ipv6Addr

Source§

#### type Output = Ipv6Addr

The resulting type after applying the `|` operator.
Source§

#### fn bitor(self, rhs: &Ipv6Addr) -> Ipv6Addr

Performs the `|` operation. Read more
1.75.0 · Source§

### impl BitOr<Ipv6Addr> for &Ipv6Addr

Source§

#### type Output = Ipv6Addr

The resulting type after applying the `|` operator.
Source§

#### fn bitor(self, rhs: Ipv6Addr) -> Ipv6Addr

Performs the `|` operation. Read more
1.75.0 · Source§

### impl BitOr for Ipv6Addr

Source§

#### type Output = Ipv6Addr

The resulting type after applying the `|` operator.
Source§

#### fn bitor(self, rhs: Ipv6Addr) -> Ipv6Addr

Performs the `|` operation. Read more
1.75.0 · Source§

### impl BitOrAssign<&Ipv6Addr> for Ipv6Addr

Source§

#### fn bitor_assign(&mut self, rhs: &Ipv6Addr)

Performs the `|=` operation. Read more
1.75.0 · Source§

### impl BitOrAssign for Ipv6Addr

Source§

#### fn bitor_assign(&mut self, rhs: Ipv6Addr)

Performs the `|=` operation. Read more
1.0.0 · Source§

### impl Clone for Ipv6Addr

Source§

#### fn clone(&self) -> Ipv6Addr

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
1.0.0 · Source§

### impl Debug for Ipv6Addr

Source§

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

Formats the value using the given formatter. Read more
1.0.0 · Source§

### impl Display for Ipv6Addr

Writes an Ipv6Addr, conforming to the canonical style described by RFC 5952.

Source§

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

Formats the value using the given formatter. Read more
1.16.0 · Source§

### impl From<[u16; 8]> for Ipv6Addr

Source§

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

Creates an `Ipv6Addr` from an eight element 16-bit array.

##### §Examples

    use std::net::Ipv6Addr;

    let addr = Ipv6Addr::from([
        0x20du16, 0x20cu16, 0x20bu16, 0x20au16,
        0x209u16, 0x208u16, 0x207u16, 0x206u16,
    ]);
    assert_eq!(
        Ipv6Addr::new(
            0x20d, 0x20c, 0x20b, 0x20a,
            0x209, 0x208, 0x207, 0x206,
        ),
        addr
    );

1.9.0 · Source§

### impl From<[u8; 16]> for Ipv6Addr

Source§

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

Creates an `Ipv6Addr` from a sixteen element byte array.

##### §Examples

    use std::net::Ipv6Addr;

    let addr = Ipv6Addr::from([
        0x19u8, 0x18u8, 0x17u8, 0x16u8, 0x15u8, 0x14u8, 0x13u8, 0x12u8,
        0x11u8, 0x10u8, 0x0fu8, 0x0eu8, 0x0du8, 0x0cu8, 0x0bu8, 0x0au8,
    ]);
    assert_eq!(
        Ipv6Addr::new(
            0x1918, 0x1716, 0x1514, 0x1312,
            0x1110, 0x0f0e, 0x0d0c, 0x0b0a,
        ),
        addr
    );

1.16.0 · Source§

### impl From<Ipv6Addr> for IpAddr

Source§

#### fn from(ipv6: Ipv6Addr) -> IpAddr

Copies this address to a new `IpAddr::V6`.

##### §Examples

    use std::net::{IpAddr, Ipv6Addr};

    let addr = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff);

    assert_eq!(
        IpAddr::V6(addr),
        IpAddr::from(addr)
    );

1.26.0 · Source§

### impl From<Ipv6Addr> for u128

Source§

#### fn from(ip: Ipv6Addr) -> u128

Uses `Ipv6Addr::to_bits` to convert an IPv6 address to a host byte order `u128`.

1.26.0 · Source§

### impl From<u128> for Ipv6Addr

Source§

#### fn from(ip: u128) -> Ipv6Addr

Uses `Ipv6Addr::from_bits` to convert a host byte order `u128` to an IPv6 address.

1.0.0 · Source§

### impl FromStr for Ipv6Addr

Source§

#### type Err = AddrParseError

The associated error which can be returned from parsing.
Source§

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

Parses a string `s` to return a value of this type. Read more
1.0.0 · Source§

### impl Hash for Ipv6Addr

Source§

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

Feeds this value into the given `Hasher`. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given `Hasher`. Read more
1.75.0 · Source§

### impl Not for &Ipv6Addr

Source§

#### type Output = Ipv6Addr

The resulting type after applying the `!` operator.
Source§

#### fn not(self) -> Ipv6Addr

Performs the unary `!` operation. Read more
1.75.0 · Source§

### impl Not for Ipv6Addr

Source§

#### type Output = Ipv6Addr

The resulting type after applying the `!` operator.
Source§

#### fn not(self) -> Ipv6Addr

Performs the unary `!` operation. Read more
1.0.0 · Source§

### impl Ord for Ipv6Addr

Source§

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

This method returns an `Ordering` between `self` and `other`. Read more
1.21.0 · Source§

#### fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

#### fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

#### fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
1.16.0 · Source§

### impl PartialEq<IpAddr> for Ipv6Addr

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.16.0 · Source§

### impl PartialEq<Ipv6Addr> for IpAddr

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.0.0 · Source§

### impl PartialEq for Ipv6Addr

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.16.0 · Source§

### impl PartialOrd<IpAddr> for Ipv6Addr

Source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 · Source§

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

Tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more
1.16.0 · Source§

### impl PartialOrd<Ipv6Addr> for IpAddr

Source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 · Source§

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

Tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more
1.0.0 · Source§

### impl PartialOrd for Ipv6Addr

Source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 · Source§

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

Tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more
Source§

### impl Step for Ipv6Addr

Source§

#### fn steps_between(start: &Ipv6Addr, end: &Ipv6Addr) -> (usize, Option<usize>)

🔬This is a nightly-only experimental API. (`step_trait` #42168)
Returns the bounds on the number of successor steps required to get from `start` to `end` like `Iterator::size_hint()`. Read more
Source§

#### fn forward_checked(start: Ipv6Addr, count: usize) -> Option<Ipv6Addr>

🔬This is a nightly-only experimental API. (`step_trait` #42168)
Returns the value that would be obtained by taking the successor of `self` `count` times. Read more
Source§

#### fn backward_checked(start: Ipv6Addr, count: usize) -> Option<Ipv6Addr>

🔬This is a nightly-only experimental API. (`step_trait` #42168)
Returns the value that would be obtained by taking the predecessor of `self` `count` times. Read more
Source§

#### unsafe fn forward_unchecked(start: Ipv6Addr, count: usize) -> Ipv6Addr

🔬This is a nightly-only experimental API. (`step_trait` #42168)
Returns the value that would be obtained by taking the successor of `self` `count` times. Read more
Source§

#### unsafe fn backward_unchecked(start: Ipv6Addr, count: usize) -> Ipv6Addr

🔬This is a nightly-only experimental API. (`step_trait` #42168)
Returns the value that would be obtained by taking the predecessor of `self` `count` times. Read more
Source§

#### fn forward(start: Self, count: usize) -> Self

🔬This is a nightly-only experimental API. (`step_trait` #42168)
Returns the value that would be obtained by taking the successor of `self` `count` times. Read more
Source§

#### fn backward(start: Self, count: usize) -> Self

🔬This is a nightly-only experimental API. (`step_trait` #42168)
Returns the value that would be obtained by taking the predecessor of `self` `count` times. Read more
1.0.0 · Source§

### impl Copy for Ipv6Addr

1.0.0 · Source§

### impl Eq for Ipv6Addr

1.0.0 · Source§

### impl StructuralPartialEq for Ipv6Addr

Source§

### impl TrustedStep for Ipv6Addr

## Auto Trait Implementations§

§

### impl Freeze for Ipv6Addr

§

### impl RefUnwindSafe for Ipv6Addr

§

### impl Send for Ipv6Addr

§

### impl Sync for Ipv6Addr

§

### impl Unpin for Ipv6Addr

§

### impl UnwindSafe for Ipv6Addr

## Blanket Implementations§

Source§

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

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit` #126799)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.