std::net::SocketAddrV6 - Rust
Description: API documentation for the Rust `SocketAddrV6` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, SocketAddrV6

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

    pub struct SocketAddrV6 { /* fields omitted */ }

An IPv6 socket address.

IPv6 socket addresses consist of an Ipv6 address, a 16-bit port number, as well as fields containing the traffic class, the flow label, and a scope identifier (see IETF RFC 2553, Section 3.3 for more details).

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

The size of a `SocketAddrV6` struct may vary depending on the target operating system.

# Examples

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

    let socket = SocketAddrV6::new(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1), 8080, 0, 0);

    assert_eq!("[2001:db8::1]:8080".parse(), Ok(socket));
    assert_eq!(socket.ip(), &Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1));
    assert_eq!(socket.port(), 8080);Run

## Methods

###

`impl SocketAddrV6`

[src]

####

`pub fn new( ip: Ipv6Addr, port: u16, flowinfo: u32, scope_id: u32 ) -> SocketAddrV6`

[src]

Creates a new socket address from an IPv6 address, a 16-bit port number, and the `flowinfo` and `scope_id` fields.

For more information on the meaning and layout of the `flowinfo` and `scope_id` parameters, see IETF RFC 2553, Section 3.3.

# Examples

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

    let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0);Run

####

`pub fn ip(&self) -> &Ipv6Addr`

[src]

Returns the IP address associated with this socket address.

# Examples

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

    let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0);
    assert_eq!(socket.ip(), &Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));Run

####

`pub fn set_ip(&mut self, new_ip: Ipv6Addr)`

1.9.0
[src]

Changes the IP address associated with this socket address.

# Examples

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

    let mut socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0);
    socket.set_ip(Ipv6Addr::new(76, 45, 0, 0, 0, 0, 0, 0));
    assert_eq!(socket.ip(), &Ipv6Addr::new(76, 45, 0, 0, 0, 0, 0, 0));Run

####

`pub fn port(&self) -> u16`

[src]

Returns the port number associated with this socket address.

# Examples

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

    let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0);
    assert_eq!(socket.port(), 8080);Run

####

`pub fn set_port(&mut self, new_port: u16)`

1.9.0
[src]

Changes the port number associated with this socket address.

# Examples

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

    let mut socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0);
    socket.set_port(4242);
    assert_eq!(socket.port(), 4242);Run

####

`pub fn flowinfo(&self) -> u32`

[src]

Returns the flow information associated with this address.

This information corresponds to the `sin6_flowinfo` field in C's `netinet/in.h`, as specified in IETF RFC 2553, Section 3.3. It combines information about the flow label and the traffic class as specified in IETF RFC 2460, respectively Section 6 and Section 7.

# Examples

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

    let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 10, 0);
    assert_eq!(socket.flowinfo(), 10);Run

####

`pub fn set_flowinfo(&mut self, new_flowinfo: u32)`

1.9.0
[src]

Changes the flow information associated with this socket address.

See the `flowinfo` method's documentation for more details.

# Examples

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

    let mut socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 10, 0);
    socket.set_flowinfo(56);
    assert_eq!(socket.flowinfo(), 56);Run

####

`pub fn scope_id(&self) -> u32`

[src]

Returns the scope ID associated with this address.

This information corresponds to the `sin6_scope_id` field in C's `netinet/in.h`, as specified in IETF RFC 2553, Section 3.3.

# Examples

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

    let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 78);
    assert_eq!(socket.scope_id(), 78);Run

####

`pub fn set_scope_id(&mut self, new_scope_id: u32)`

1.9.0
[src]

Change the scope ID associated with this socket address.

See the `scope_id` method's documentation for more details.

# Examples

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

    let mut socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 78);
    socket.set_scope_id(42);
    assert_eq!(socket.scope_id(), 42);Run

## Trait Implementations

###

`impl ToSocketAddrs for SocketAddrV6`

[src]

#### `type Iter = IntoIter<SocketAddr>`

Returned iterator over socket addresses which this type may correspond to. Read more

####

`fn to_socket_addrs(&self) -> Result<IntoIter<SocketAddr>>`

[src]

Converts this object to an iterator of resolved `SocketAddr`s. Read more

###

`impl PartialEq<SocketAddrV6> for SocketAddrV6`

[src]

####

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

[src]

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

####

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

[src]

This method tests for `!=`.

###

`impl Eq for SocketAddrV6`

[src]

###

`impl From<SocketAddrV6> for SocketAddr`

1.16.0
[src]

####

`fn from(sock6: SocketAddrV6) -> SocketAddr`

[src]

Converts a `SocketAddrV6` into a `SocketAddr::V6`.

###

`impl Display for SocketAddrV6`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl Debug for SocketAddrV6`

[src]

####

`fn fmt(&self, fmt: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl FromStr for SocketAddrV6`

1.5.0
[src]

#### `type Err = AddrParseError`

The associated error which can be returned from parsing.

####

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

[src]

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

###

`impl Hash for SocketAddrV6`

[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 Copy for SocketAddrV6`

[src]

###

`impl Clone for SocketAddrV6`

[src]

####

`fn clone(&self) -> SocketAddrV6`

[src]

Returns a copy of the value. Read more

####

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

[src]

Performs copy-assignment from `source`. Read more

## Auto Trait Implementations

###

`impl Send for SocketAddrV6`

###

`impl Sync for SocketAddrV6`

## Blanket Implementations

###

`impl<T> From for T`

[src]

####

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

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

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

[src]

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

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

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

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

[src]

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

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

[src]

Immutably borrows from an owned value. Read more

###

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

[src]

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

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

[src]

Mutably borrows from an owned value. Read more

###

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

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

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

###

`impl<T> ToOwned for T where T: Clone,`

[src]

#### `type Owned = T`

####

`fn to_owned(&self) -> T`

[src]

Creates owned data from borrowed data, usually by cloning. Read more

####

`fn clone_into(&self, target: &mut T)`

[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

###

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

[src]

####

`fn to_string(&self) -> String`

[src]

Converts the given value to a `String`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse 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`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)