SocketAddr in core::net - Rust
Description: An internet socket address, either IPv4 or IPv6.

# Enum SocketAddr

1.77.0 · Source

    pub enum SocketAddr {
        V4(SocketAddrV4),
        V6(SocketAddrV6),
    }

Expand description

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.

## §Portability

`SocketAddr` 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.

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

§1.77.0

### V4(SocketAddrV4)

An IPv4 socket address.

§1.77.0

### V6(SocketAddrV6)

An IPv6 socket address.

## Implementations§

Source§

### impl SocketAddr

Source

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

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

Parse a socket address from a slice of bytes.

    #![feature(addr_parse_ascii)]

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

    let socket_v4 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
    let socket_v6 = SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), 8080);

    assert_eq!(SocketAddr::parse_ascii(b"127.0.0.1:8080"), Ok(socket_v4));
    assert_eq!(SocketAddr::parse_ascii(b"[::1]:8080"), Ok(socket_v6));

Source§

### impl SocketAddr

1.7.0 (const: 1.69.0) · Source

#### pub const fn new(ip: IpAddr, port: u16) -> SocketAddr

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

1.7.0 (const: 1.69.0) · Source

#### pub const fn ip(&self) -> IpAddr

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

1.9.0 (const: 1.87.0) · Source

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

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

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::{IpAddr, Ipv4Addr, SocketAddr};

    let socket = SocketAddr::new(IpAddr::V4(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::{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);

1.16.0 (const: 1.69.0) · Source

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

1.16.0 (const: 1.69.0) · Source

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

1.0.0 · Source§

### impl Clone for SocketAddr

Source§

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

Returns a copy 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 SocketAddr

Source§

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

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

### impl Display for SocketAddr

Source§

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

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

### impl<I: Into<IpAddr>> From<(I, u16)> for SocketAddr

Source§

#### fn from(pieces: (I, u16)) -> SocketAddr

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

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

`u16` is treated as port of the newly created `SocketAddr`.

1.16.0 · Source§

### impl From<SocketAddrV4> for SocketAddr

Source§

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

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

1.16.0 · Source§

### impl From<SocketAddrV6> for SocketAddr

Source§

#### fn from(sock6: SocketAddrV6) -> SocketAddr

Converts a `SocketAddrV6` into a `SocketAddr::V6`.

1.0.0 · Source§

### impl FromStr for SocketAddr

Source§

#### type Err = AddrParseError

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

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

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

### impl Hash for SocketAddr

Source§

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

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

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

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

### impl Ord for SocketAddr

Source§

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

Source§

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

Source§

#### fn partial_cmp(&self, other: &SocketAddr) -> 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 Copy for SocketAddr

1.0.0 · Source§

### impl Eq for SocketAddr

1.0.0 · Source§

### impl StructuralPartialEq for SocketAddr

## Auto Trait Implementations§

§

### impl Freeze for SocketAddr

§

### impl RefUnwindSafe for SocketAddr

§

### impl Send for SocketAddr

§

### impl Sync for SocketAddr

§

### impl Unpin for SocketAddr

§

### impl UnwindSafe for SocketAddr

## 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, 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.