Enum addr_hal::SocketAddr

pub enum SocketAddr<SA4: SocketAddressV4, SA6: SocketAddressV6> {
    V4(SocketAddrV4<SA4>),
    V6(SocketAddrV6<SA6>),
}

An internet socket address, either IPv4 or IPv6.

Internet socket addresses consist of an IP address, a 16-bit port number, as well as possibly some version-dependent additional information. See SocketAddrV4's and SocketAddrV6's respective documentation for more details.

The size of a SocketAddr instance may vary depending on the target operating system.

Examples

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);

assert_eq!("127.0.0.1:8080".parse(), Ok(socket));
assert_eq!(socket.port(), 8080);
assert_eq!(socket.is_ipv4(), true);

Variants

V4(SocketAddrV4<SA4>)

An IPv4 socket address.

V6(SocketAddrV6<SA6>)

An IPv6 socket address.

Methods

impl<SA4: SocketAddressV4, SA6: SocketAddressV6> SocketAddr<SA4, SA6>

pub fn new(
    ip: IpAddr<SA4::IpAddress, SA6::IpAddress>,
    port: u16
) -> SocketAddr<SA4, SA6>

Creates a new socket address from an IP address and a port number.

Examples

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
assert_eq!(socket.ip(), IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
assert_eq!(socket.port(), 8080);

pub fn ip(&self) -> IpAddr<SA4::IpAddress, SA6::IpAddress>

Returns the IP address associated with this socket address.

Examples

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
assert_eq!(socket.ip(), IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));

pub fn set_ip(&mut self, new_ip: IpAddr<SA4::IpAddress, SA6::IpAddress>)

Changes the IP address associated with this socket address.

Examples

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

let mut socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
socket.set_ip(IpAddr::V4(Ipv4Addr::new(10, 10, 0, 1)));
assert_eq!(socket.ip(), IpAddr::V4(Ipv4Addr::new(10, 10, 0, 1)));

pub fn port(&self) -> u16

Returns the port number associated with this socket address.

Examples

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
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::{IpAddr, Ipv4Addr, SocketAddr};

let mut socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
socket.set_port(1025);
assert_eq!(socket.port(), 1025);

pub fn is_ipv4(&self) -> bool

Returns true if the IP address in this SocketAddr is an IPv4 address, and false otherwise.

Examples

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
assert_eq!(socket.is_ipv4(), true);
assert_eq!(socket.is_ipv6(), false);

pub fn is_ipv6(&self) -> bool

Returns true if the IP address in this SocketAddr is an IPv6 address, and false otherwise.

Examples

use std::net::{IpAddr, Ipv6Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 65535, 0, 1)), 8080);
assert_eq!(socket.is_ipv4(), false);
assert_eq!(socket.is_ipv6(), true);

Trait Implementations

impl<SA4: SocketAddressV4, SA6: SocketAddressV6> Clone for SocketAddr<SA4, SA6>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<SA4: SocketAddressV4, SA6: SocketAddressV6> Copy for SocketAddr<SA4, SA6>

impl<SA4: SocketAddressV4, SA6: SocketAddressV6> Debug for SocketAddr<SA4, SA6>

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

Formats the value using the given formatter.

impl<SA4: SocketAddressV4, SA6: SocketAddressV6> Display for SocketAddr<SA4, SA6>

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

Formats the value using the given formatter.

impl<SA4: SocketAddressV4, SA6: SocketAddressV6> Eq for SocketAddr<SA4, SA6>

impl<SA4: SocketAddressV4, SA6: SocketAddressV6, I: Into<IpAddr<SA4::IpAddress, SA6::IpAddress>>> From<(I, u16)> for SocketAddr<SA4, SA6>

fn from(pieces: (I, u16)) -> SocketAddr<SA4, SA6>

Converts a tuple struct (Into<IpAddr>, u16) into a SocketAddr.

This conversion creates a SocketAddr::V4 for a IpAddr::V4 and creates a SocketAddr::V6 for a IpAddr::V6.

u16 is treated as port of the newly created SocketAddr.

impl<SA4: SocketAddressV4, SA6: SocketAddressV6> From<SocketAddrV4<SA4>> for SocketAddr<SA4, SA6>

fn from(sock4: SocketAddrV4<SA4>) -> SocketAddr<SA4, SA6>

Converts a SocketAddrV4 into a SocketAddr::V4.

impl<SA4: SocketAddressV4, SA6: SocketAddressV6> From<SocketAddrV6<SA6>> for SocketAddr<SA4, SA6>

fn from(sock6: SocketAddrV6<SA6>) -> SocketAddr<SA4, SA6>

Converts a SocketAddrV6 into a SocketAddr::V6.

impl<SA4: SocketAddressV4, SA6: SocketAddressV6> FromStr for SocketAddr<SA4, SA6>

type Err = AddrParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SocketAddr<SA4, SA6>, AddrParseError>

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

impl<SA4: SocketAddressV4, SA6: SocketAddressV6> Hash for SocketAddr<SA4, SA6>

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<SA4: SocketAddressV4, SA6: SocketAddressV6> PartialEq<SocketAddr<SA4, SA6>> for SocketAddr<SA4, SA6>

fn eq(&self, other: &SocketAddr<SA4, SA6>) -> bool

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

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

This method tests for !=.

impl<SA4: SocketAddressV4, SA6: SocketAddressV6> ToSocketAddrs<SA4, SA6> for SocketAddr<SA4, SA6>

type Iter = IntoIter<SocketAddr<SA4, SA6>>

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

fn to_socket_addrs(
    &self
) -> Result<IntoIter<SocketAddr<SA4, SA6>>, ToSocketAddrError>

Converts this object to an iterator of resolved SocketAddrs.