SocketAddrV6 in core::net - Rust (original) (raw)
Struct SocketAddrV6
1.77.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.
§Portability
SocketAddrV6 is intended to be a portable representation of socket addresses and is likely not the same as the internal socket address type used by the target operating system’s API. Like allrepr(Rust) structs, however, its exact layout remains undefined and should not be relied upon between builds.
§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 SocketAddrV6with 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:🥅:{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));🔬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:🥅:{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));1.0.0 (const: 1.69.0) · Source
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_idparameters, see IETF RFC 2553, Section 3.3.
§Examples
use std:🥅:{SocketAddrV6, Ipv6Addr};
let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0);1.0.0 (const: 1.69.0) · Source
Returns the IP address associated with this socket address.
§Examples
use std:🥅:{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));1.9.0 (const: 1.87.0) · Source
Changes the IP address associated with this socket address.
§Examples
use std:🥅:{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));1.0.0 (const: 1.69.0) · Source
Returns the port number associated with this socket address.
§Examples
use std:🥅:{SocketAddrV6, Ipv6Addr};
let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 0, 0);
assert_eq!(socket.port(), 8080);1.9.0 (const: 1.87.0) · Source
Changes the port number associated with this socket address.
§Examples
use std:🥅:{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);1.0.0 (const: 1.69.0) · Source
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:🥅:{SocketAddrV6, Ipv6Addr};
let socket = SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 8080, 10, 0);
assert_eq!(socket.flowinfo(), 10);1.9.0 (const: 1.87.0) · Source
Changes the flow information associated with this socket address.
See SocketAddrV6::flowinfo’s documentation for more details.
§Examples
use std:🥅:{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);1.0.0 (const: 1.69.0) · Source
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:🥅:{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);1.9.0 (const: 1.87.0) · Source
Changes the scope ID associated with this socket address.
See SocketAddrV6::scope_id’s documentation for more details.
§Examples
use std:🥅:{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);1.16.0 (const: unstable) · Source§
The associated error which can be returned from parsing.
Parses a string s to return a value of this type. Read more
Tests for self and other values to be equal, and is used by ==.
Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
This method returns an ordering between self and other values if one exists. Read more
Tests less than (for self and other) and is used by the < operator. Read more
Tests less than or equal to (for self and other) and is used by the<= operator. Read more
Tests greater than (for self and other) and is used by the >operator. Read more
Tests greater than or equal to (for self and other) and is used by the >= operator. Read more