Struct SocketAddrV6

pub struct SocketAddrV6 { /* private fields */ }

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.

Textual representation

SocketAddrV6 provides a FromStr implementation, based on the bracketed format recommended by IETF RFC 5952, with scope identifiers based on those specified in IETF RFC 4007.

It accepts addresses consisting of the following elements, in order:

• A left square bracket ([)
• The textual representation of an IPv6 address
• Optionally, a percent sign (%) followed by the scope identifier encoded as a decimal integer
• A right square bracket (])
• A colon (:)
• The port, encoded as a decimal integer.

For example, the string [2001:db8::413]:443 represents a SocketAddrV6 with the address 2001:db8::413 and port 443. The string [2001:db8::413%612]:443 represents the same address and port, with a scope identifier of 612.

Other formats are not accepted.

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

let mut with_scope = socket.clone();
with_scope.set_scope_id(3);
assert_eq!("[2001:db8::1%3]:8080".parse(), Ok(with_scope));

Implementations

impl SocketAddrV6

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

impl SocketAddrV6

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for SocketAddrV6

fn clone(&self) -> SocketAddrV6

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SocketAddrV6

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

Formats the value using the given formatter.

impl Display for SocketAddrV6

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

Formats the value using the given formatter.

impl From<SocketAddrV6> for SocketAddr

fn from(sock6: SocketAddrV6) -> SocketAddr

Converts a SocketAddrV6 into a SocketAddr::V6.

impl FromStr for SocketAddrV6

type Err = AddrParseError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for SocketAddrV6

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SocketAddrV6

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SocketAddrV6

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for SocketAddrV6

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl ToSocketAddrs for SocketAddrV6

type Iter = IntoIter<SocketAddr>

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

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

Converts this object to an iterator of resolved SocketAddrs.

impl Copy for SocketAddrV6

impl Eq for SocketAddrV6

impl StructuralPartialEq for SocketAddrV6