Struct SocketAddrV4

pub struct SocketAddrV4 { /* private fields */ }

An IPv4 socket address.

IPv4 socket addresses consist of an IPv4 address and a 16-bit port number, as stated in IETF RFC 793.

See SocketAddr for a type encompassing both IPv4 and IPv6 socket addresses.

Portability

SocketAddrV4 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 all repr(Rust) structs, however, its exact layout remains undefined and should not be relied upon between builds.

Textual representation

SocketAddrV4 provides a FromStr implementation. It accepts an IPv4 address in its textual representation, followed by a single :, followed by the port encoded as a decimal integer. Other formats are not accepted.

Examples

use std::net::{Ipv4Addr, SocketAddrV4};

let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);

assert_eq!("127.0.0.1:8080".parse(), Ok(socket));
assert_eq!(socket.ip(), &Ipv4Addr::new(127, 0, 0, 1));
assert_eq!(socket.port(), 8080);

Implementations

impl SocketAddrV4

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

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

Parse an IPv4 socket address from a slice of bytes.

#![feature(addr_parse_ascii)]

use std::net::{Ipv4Addr, SocketAddrV4};

let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);

assert_eq!(SocketAddrV4::parse_ascii(b"127.0.0.1:8080"), Ok(socket));

impl SocketAddrV4

pub const fn new(ip: Ipv4Addr, port: u16) -> SocketAddrV4

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

Examples

use std::net::{SocketAddrV4, Ipv4Addr};

let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);

pub const fn ip(&self) -> &Ipv4Addr

Returns the IP address associated with this socket address.

Examples

use std::net::{SocketAddrV4, Ipv4Addr};

let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);
assert_eq!(socket.ip(), &Ipv4Addr::new(127, 0, 0, 1));

pub const fn set_ip(&mut self, new_ip: Ipv4Addr)

Changes the IP address associated with this socket address.

Examples

use std::net::{SocketAddrV4, Ipv4Addr};

let mut socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);
socket.set_ip(Ipv4Addr::new(192, 168, 0, 1));
assert_eq!(socket.ip(), &Ipv4Addr::new(192, 168, 0, 1));

pub const fn port(&self) -> u16

Returns the port number associated with this socket address.

Examples

use std::net::{SocketAddrV4, Ipv4Addr};

let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);
assert_eq!(socket.port(), 8080);

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

Changes the port number associated with this socket address.

Examples

use std::net::{SocketAddrV4, Ipv4Addr};

let mut socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);
socket.set_port(4242);
assert_eq!(socket.port(), 4242);

Trait Implementations

impl Clone for SocketAddrV4

fn clone(&self) -> SocketAddrV4

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SocketAddrV4

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

Formats the value using the given formatter.

impl Display for SocketAddrV4

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

Formats the value using the given formatter.

impl From<SocketAddrV4> for SocketAddr

fn from(sock4: SocketAddrV4) -> SocketAddr

Converts a SocketAddrV4 into a SocketAddr::V4.

impl FromStr for SocketAddrV4

type Err = AddrParseError

The associated error which can be returned from parsing.

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

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

impl Hash for SocketAddrV4

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 SocketAddrV4

fn cmp(&self, other: &SocketAddrV4) -> 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 SocketAddrV4

fn eq(&self, other: &SocketAddrV4) -> 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 SocketAddrV4

fn partial_cmp(&self, other: &SocketAddrV4) -> 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 SocketAddrArg for SocketAddrV4

unsafe fn with_sockaddr<R>( &self, f: impl FnOnce(*const SocketAddrOpaque, u32) -> R, ) -> R

Call a closure with the pointer and length to the corresponding C type.

fn as_any(&self) -> SocketAddrAny

Convert to SocketAddrAny.

unsafe fn write_sockaddr(&self, storage: *mut SocketAddrStorage) -> u32

Encode an address into a SocketAddrStorage.

impl ToSocketAddrs for SocketAddrV4

type Iter = IntoIter<SocketAddr>

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

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

Converts this object to an iterator of resolved SocketAddrs.

impl ToSocketAddrs for SocketAddrV4

type Iter = IntoIter<SocketAddr>

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

fn to_socket_addrs( &self, ) -> ToSocketAddrsFuture<<SocketAddrV4 as ToSocketAddrs>::Iter>

Converts this object to an iterator of resolved SocketAddrs.

impl TryFrom<SocketAddrAny> for SocketAddrV4

fn try_from( value: SocketAddrAny, ) -> Result<SocketAddrV4, <SocketAddrV4 as TryFrom<SocketAddrAny>>::Error>

Convert if the address is an IPv4 address.

Returns Err(Errno::AFNOSUPPORT) if the address family is not IPv4.

type Error = Errno

The type returned in the event of a conversion error.

impl Copy for SocketAddrV4

impl Eq for SocketAddrV4

impl StructuralPartialEq for SocketAddrV4