# Struct std::net::Ipv6Addr 1.0.0 [−] [src]

    pub struct Ipv6Addr { /* fields omitted */ }

An IPv6 address.

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

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

# 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);Run

## Methods

### `impl Ipv6Addr`
[src]

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

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);Run

#### `pub fn localhost() -> Ipv6Addr`
[src]

🔬 This is a nightly-only experimental API. (`ip_constructors` #44582)

requires greater scrutiny before stabilization

Creates a new IPv6 address representing localhost: `::1`.

# Examples

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

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

#### `pub fn unspecified() -> Ipv6Addr`
[src]

🔬 This is a nightly-only experimental API. (`ip_constructors` #44582)

requires greater scrutiny before stabilization

Creates a new IPv6 address representing the unspecified address: `::`

# Examples

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

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

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

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]);Run

#### `pub fn is_unspecified(&self) -> bool`
1.7.0
[src]

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);Run

#### `pub fn is_loopback(&self) -> bool`
1.7.0
[src]

Returns `true` if this is a loopback address (::1).

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_loopback(), false);
    assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_loopback(), true);Run

#### `pub fn is_global(&self) -> bool`
[src]

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

extra functionality has not been scrutinized to the level that it should be to be stable

Returns `true` if the address appears to be globally routable.

The following return `false`:

- the loopback address
- link-local, site-local, and unique local unicast addresses
- interface-, link-, realm-, admin- and site-local multicast addresses

# Examples

    #![feature(ip)]

    use std::net::Ipv6Addr;

    fn main() {
        assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_global(), true);
        assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_global(), false);
        assert_eq!(Ipv6Addr::new(0, 0, 0x1c9, 0, 0, 0xafc8, 0, 0x1).is_global(), true);
    }Run

#### `pub fn is_unique_local(&self) -> bool`
[src]

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

extra functionality has not been scrutinized to the level that it should be to be stable

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

This property is defined in IETF RFC 4193.

# Examples

    #![feature(ip)]

    use std::net::Ipv6Addr;

    fn main() {
        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);
    }Run

#### `pub fn is_unicast_link_local(&self) -> bool`
[src]

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

extra functionality has not been scrutinized to the level that it should be to be stable

Returns `true` if the address is unicast and link-local (fe80::/10).

This property is defined in IETF RFC 4291.

# Examples

    #![feature(ip)]

    use std::net::Ipv6Addr;

    fn main() {
        assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_link_local(),
                   false);
        assert_eq!(Ipv6Addr::new(0xfe8a, 0, 0, 0, 0, 0, 0, 0).is_unicast_link_local(), true);
    }Run

#### `pub fn is_unicast_site_local(&self) -> bool`
[src]

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

extra functionality has not been scrutinized to the level that it should be to be stable

Returns `true` if this is a deprecated unicast site-local address (fec0::/10).

# Examples

    #![feature(ip)]

    use std::net::Ipv6Addr;

    fn main() {
        assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_site_local(),
                   false);
        assert_eq!(Ipv6Addr::new(0xfec2, 0, 0, 0, 0, 0, 0, 0).is_unicast_site_local(), true);
    }Run

#### `pub fn is_documentation(&self) -> bool`
[src]

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

extra functionality has not been scrutinized to the level that it should be to be stable

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

This property is defined in IETF RFC 3849.

# Examples

    #![feature(ip)]

    use std::net::Ipv6Addr;

    fn main() {
        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);
    }Run

#### `pub fn is_unicast_global(&self) -> bool`
[src]

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

extra functionality has not been scrutinized to the level that it should be to be stable

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

The following return false:

- the loopback address
- the link-local addresses
- the (deprecated) site-local addresses
- unique local addresses
- the unspecified address
- the address range reserved for documentation

# Examples

    #![feature(ip)]

    use std::net::Ipv6Addr;

    fn main() {
        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);
    }Run

#### `pub fn multicast_scope(&self) -> Option<Ipv6MulticastScope>`
[src]

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

extra functionality has not been scrutinized to the level that it should be to be stable

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

# Examples

    #![feature(ip)]

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

    fn main() {
        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);
    }Run

#### `pub fn is_multicast(&self) -> bool`
1.7.0
[src]

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);Run

#### `pub fn to_ipv4(&self) -> Option<Ipv4Addr>`
[src]

Converts this address to an IPv4 address. Returns `None` if this address is neither IPv4-compatible or IPv4-mapped.

::a.b.c.d and ::ffff:a.b.c.d become a.b.c.d

# 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)));Run

#### `pub fn octets(&self) -> [u8; 16]`
1.12.0
[src]

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(),
               [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);Run

## Trait Implementations

### `impl Copy for Ipv6Addr`
[src]

### `impl Display for Ipv6Addr`
[src]

#### `fn fmt(&self, fmt: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

### `impl Debug for Ipv6Addr`
[src]

#### `fn fmt(&self, fmt: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter.

### `impl Clone for Ipv6Addr`
[src]

#### `fn clone(&self) -> Ipv6Addr`
[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`
[src]

Performs copy-assignment from `source`. Read more

### `impl PartialEq for Ipv6Addr`
[src]

#### `fn eq(&self, other: &Ipv6Addr) -> bool`
[src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `fn ne(&self, other: &Rhs) -> bool`
[src]

This method tests for `!=`.

### `impl PartialEq<IpAddr> for Ipv6Addr`
1.16.0
[src]

#### `fn eq(&self, other: &IpAddr) -> bool`
[src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `fn ne(&self, other: &Rhs) -> bool`
[src]

This method tests for `!=`.

### `impl Eq for Ipv6Addr`
[src]

### `impl Hash for Ipv6Addr`
[src]

#### `fn hash<H: Hasher>(&self, s: &mut H)`
[src]

Feeds this value into the given [`Hasher`]. Read more

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

Feeds a slice of this type into the given [`Hasher`]. Read more

### `impl PartialOrd for Ipv6Addr`
[src]

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

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

#### `fn lt(&self, other: &Rhs) -> bool`
[src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `fn le(&self, other: &Rhs) -> bool`
[src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `fn gt(&self, other: &Rhs) -> bool`
[src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

#### `fn ge(&self, other: &Rhs) -> bool`
[src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

### `impl PartialOrd<IpAddr> for Ipv6Addr`
1.16.0
[src]

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

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

#### `fn lt(&self, other: &Rhs) -> bool`
[src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `fn le(&self, other: &Rhs) -> bool`
[src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `fn gt(&self, other: &Rhs) -> bool`
[src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

#### `fn ge(&self, other: &Rhs) -> bool`
[src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

### `impl Ord for Ipv6Addr`
[src]

#### `fn cmp(&self, other: &Ipv6Addr) -> Ordering`
[src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `fn max(self, other: Self) -> Self`
1.21.0
[src]

Compares and returns the maximum of two values. Read more

#### `fn min(self, other: Self) -> Self`
1.21.0
[src]

Compares and returns the minimum of two values. Read more

### `impl From<u128> for Ipv6Addr`
[src]

#### `fn from(ip: u128) -> Ipv6Addr`
[src]

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

### `impl FromStr for Ipv6Addr`
[src]

#### `type Err = AddrParseError`

The associated error which can be returned from parsing.

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

Parses a string `s` to return a value of this type. Read more

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)