SocketAddrV4 in std::net - Rust
Description: An IPv4 socket address.

Skip to main content

## SocketAddrV4

# Struct SocketAddrV4

1.0.0 · Source

    pub struct SocketAddrV4 { /* private fields */ }

Expand description

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§

Source§

### impl SocketAddrV4

Source

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

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

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

Source§

### impl SocketAddrV4

1.0.0 (const: 1.69.0) · Source

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

1.0.0 (const: 1.69.0) · Source

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

1.9.0 (const: 1.87.0) · Source

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

1.0.0 (const: 1.69.0) · Source

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

1.9.0 (const: 1.87.0) · Source

#### 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§

1.0.0 · Source§

### impl Clone for SocketAddrV4

Source§

#### fn clone(&self) -> SocketAddrV4

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
1.0.0 · Source§

### impl Debug for SocketAddrV4

Source§

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

Formats the value using the given formatter. Read more
1.0.0 · Source§

### impl Display for SocketAddrV4

Source§

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

Formats the value using the given formatter. Read more
1.16.0 (const: unstable) · Source§

### impl From<SocketAddrV4> for SocketAddr

Source§

#### fn from(sock4: SocketAddrV4) -> SocketAddr

Converts a `SocketAddrV4` into a `SocketAddr::V4`.

1.5.0 · Source§

### impl FromStr for SocketAddrV4

Source§

#### type Err = AddrParseError

The associated error which can be returned from parsing.
Source§

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

Parses a string `s` to return a value of this type. Read more
1.0.0 · Source§

### impl Hash for SocketAddrV4

Source§

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

Feeds this value into the given `Hasher`. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given `Hasher`. Read more
1.0.0 · Source§

### impl Ord for SocketAddrV4

Source§

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

This method returns an `Ordering` between `self` and `other`. Read more
1.21.0 · Source§

#### fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

#### fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
1.0.0 · Source§

### impl PartialEq for SocketAddrV4

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

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

### impl PartialOrd for SocketAddrV4

Source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 · Source§

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

Tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more
1.0.0 · Source§

### impl ToSocketAddrs for SocketAddrV4

Source§

#### type Iter = IntoIter<SocketAddr>

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

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

Converts this object to an iterator of resolved `SocketAddr`s. Read more
1.0.0 · Source§

### impl Copy for SocketAddrV4

1.0.0 · Source§

### impl Eq for SocketAddrV4

1.0.0 · Source§

### impl StructuralPartialEq for SocketAddrV4

## Auto Trait Implementations§

§

### impl Freeze for SocketAddrV4

§

### impl RefUnwindSafe for SocketAddrV4

§

### impl Send for SocketAddrV4

§

### impl Sync for SocketAddrV4

§

### impl Unpin for SocketAddrV4

§

### impl UnsafeUnpin for SocketAddrV4

§

### impl UnwindSafe for SocketAddrV4

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit` #126799)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T> ToString for T
where T: Display + ?Sized,

Source§

#### fn to_string(&self) -> String

Converts the given value to a `String`. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.