Struct std::net::SocketAddrV6

[+] Show declaration

pub struct SocketAddrV6 { /* fields omitted */ }

[−] 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.

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

Methods

impl SocketAddrV6[−]

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

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

Trait Implementations

impl ToSocketAddrs for SocketAddrV6[+]

[+] Show hidden undocumented items

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 PartialEq<SocketAddrV6> for SocketAddrV6[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

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

This method tests for !=.

impl Eq for SocketAddrV6

impl Hash for SocketAddrV6[+]

[+] Show hidden undocumented items

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

Feeds this value into the given [Hasher].

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

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

impl Copy for SocketAddrV6

impl Display for SocketAddrV6[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Debug for SocketAddrV6[+]

[+] Show hidden undocumented items

fn fmt(&self, fmt: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl FromStr for SocketAddrV6[+]

[+] Show hidden undocumented items

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 From<SocketAddrV6> for SocketAddr[+]

fn from(sock6: SocketAddrV6) -> SocketAddr[−]

Converts a SocketAddrV6 into a SocketAddr::V6.

impl Clone for SocketAddrV6[+]

[+] Show hidden undocumented items

fn clone(&self) -> SocketAddrV6[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.