# Struct std::net::SocketAddrV6

1.0.0 · source ·

    pub struct SocketAddrV6 { /* private fields */ }

Expand description

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. Do not assume that this type has the same memory layout as the underlying system representation.

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

## Implementations§

source§

### impl SocketAddrV6

source

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

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

Parse an IPv6 socket address from a slice of bytes.

    #![feature(addr_parse_ascii)]

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

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

    assert_eq!(SocketAddrV6::parse_ascii(b"[2001:db8::1]:8080"), Ok(socket));

Run
source§

### impl SocketAddrV6

const: 1.69.0 · source

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

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
const: 1.69.0 · source

#### pub const fn ip(&self) -> &Ipv6Addr

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
1.9.0 · source

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

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
const: 1.69.0 · source

#### pub const fn port(&self) -> u16

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
1.9.0 · source

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

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
const: 1.69.0 · source

#### pub const fn flowinfo(&self) -> u32

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
1.9.0 · source

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

Changes the flow information associated with this socket address.

See `SocketAddrV6::flowinfo`’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
const: 1.69.0 · source

#### pub const fn scope_id(&self) -> u32

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
1.9.0 · source

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

Changes the scope ID associated with this socket address.

See `SocketAddrV6::scope_id`’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§

source§

### impl Clone for SocketAddrV6

source§

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

Returns a copy of the value. Read more
source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for SocketAddrV6

source§

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

Formats the value using the given formatter. Read more
source§

### impl Display for SocketAddrV6

source§

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

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

### impl From<SocketAddrV6> for SocketAddr

source§

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

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

1.5.0 · source§

### impl FromStr for SocketAddrV6

§

#### type Err = AddrParseError

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

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

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

### impl Hash for SocketAddrV6

source§

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

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

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

Feeds a slice of this type into the given `Hasher`. Read more
source§

### impl Ord for SocketAddrV6

source§

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

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

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

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

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

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

#### fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

### impl PartialEq for SocketAddrV6

source§

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

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

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

### impl PartialOrd for SocketAddrV6

source§

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

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

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

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

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

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

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

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

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

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

### impl ToSocketAddrs for SocketAddrV6

§

#### type Iter = IntoIter<SocketAddr>

Returned iterator over socket addresses which this type may correspond to.
source§

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

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

### impl Copy for SocketAddrV6

source§

### impl Eq for SocketAddrV6

source§

### impl StructuralEq for SocketAddrV6

source§

### impl StructuralPartialEq for SocketAddrV6

## Auto Trait Implementations§

§

### impl RefUnwindSafe for SocketAddrV6

§

### impl Send for SocketAddrV6

§

### impl Sync for SocketAddrV6

§

### impl Unpin for SocketAddrV6

§

### impl UnwindSafe for SocketAddrV6

## Blanket Implementations§

source§

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

source§

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

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

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

source§

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

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

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

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

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

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

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

source§

#### default fn to_string(&self) -> String

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

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

§

#### 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 Twhere U: TryFrom<T>,

§

#### 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.