# Enum std::net::SocketAddr 1.0.0[−][src]

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

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

Run

## Variants

`V4(SocketAddrV4)`

An IPv4 socket address.

`V6(SocketAddrV6)`

An IPv6 socket address.

## Implementations

### `impl SocketAddr`[src]

#### `pub fn new(ip: IpAddr, port: u16) -> SocketAddr` 1.7.0[src]

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

Run

#### `pub fn ip(&self) -> IpAddr` 1.7.0[src]

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

Run

#### `pub fn set_ip(&mut self, new_ip: IpAddr)`1.9.0[src]

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

Run

#### `pub fn port(&self) -> u16`[src]

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

Run

#### `pub fn set_port(&mut self, new_port: u16)`1.9.0[src]

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

Run

#### `pub fn is_ipv4(&self) -> bool` 1.16.0[src]

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

Run

#### `pub fn is_ipv6(&self) -> bool` 1.16.0[src]

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

Run

## Trait Implementations

### `impl Clone for SocketAddr`[src]

#### `fn clone(&self) -> SocketAddr`[src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`[src]

Performs copy-assignment from `source`. Read more

### `impl Copy for SocketAddr`[src]

### `impl Debug for SocketAddr`[src]

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

Formats the value using the given formatter. Read more

### `impl Display for SocketAddr`[src]

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

Formats the value using the given formatter. Read more

### `impl Eq for SocketAddr`[src]

### `impl<I: Into<IpAddr>> From<(I, u16)> for SocketAddr` 1.17.0[src]

#### `fn from(pieces: (I, u16)) -> SocketAddr`[src]

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 From<SocketAddrV4> for SocketAddr` 1.16.0[src]

#### `fn from(sock4: SocketAddrV4) -> SocketAddr`[src]

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

### `impl From<SocketAddrV6> for SocketAddr` 1.16.0[src]

#### `fn from(sock6: SocketAddrV6) -> SocketAddr`[src]

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

### `impl FromStr for SocketAddr`[src]

#### `type Err = AddrParseError`

The associated error which can be returned from parsing.

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

Parses a string `s` to return a value of this type. Read more

### `impl Hash for SocketAddr`[src]

#### `fn hash<__H: Hasher>(&self, state: &mut __H)`[src]

Feeds this value into the given `Hasher`. Read more

#### `pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,` 1.3.0[src]

Feeds a slice of this type into the given `Hasher`. Read more

### `impl Ord for SocketAddr`[src]

#### `fn cmp(&self, other: &SocketAddr) -> Ordering`[src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `#[must_use]pub fn max(self, other: Self) -> Self` 1.21.0[src]

Compares and returns the maximum of two values. Read more

#### `#[must_use]pub fn min(self, other: Self) -> Self` 1.21.0[src]

Compares and returns the minimum of two values. Read more

#### `#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self` 1.50.0[src]

Restrict a value to a certain interval. Read more

### `impl PartialEq<SocketAddr> for SocketAddr`[src]

#### `fn eq(&self, other: &SocketAddr) -> bool`[src]

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

#### `fn ne(&self, other: &SocketAddr) -> bool`[src]

This method tests for `!=`.

### `impl PartialOrd<SocketAddr> for SocketAddr`[src]

#### `fn partial_cmp(&self, other: &SocketAddr) -> Option<Ordering>`[src]

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

#### `#[must_use]pub fn lt(&self, other: &Rhs) -> bool`[src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `#[must_use]pub fn le(&self, other: &Rhs) -> bool`[src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `#[must_use]pub fn gt(&self, other: &Rhs) -> bool`[src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

#### `#[must_use]pub fn ge(&self, other: &Rhs) -> bool`[src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

### `impl StructuralEq for SocketAddr`[src]

### `impl StructuralPartialEq for SocketAddr`[src]

### `impl ToSocketAddrs for SocketAddr`[src]

#### `type Iter = IntoIter<SocketAddr>`

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

#### `fn to_socket_addrs(&self) -> Result<IntoIter<SocketAddr>>`[src]

Converts this object to an iterator of resolved `SocketAddr`s. Read more

## Auto Trait Implementations

### `impl RefUnwindSafe for SocketAddr`

### `impl Send for SocketAddr`

### `impl Sync for SocketAddr`

### `impl Unpin for SocketAddr`

### `impl UnwindSafe for SocketAddr`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId`[src]

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

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized> Read for &mut Rimpl<W: Write + ?Sized> Write for &mut W`
`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized> Read for &mut Rimpl<W: Write + ?Sized> Write for &mut W`
`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `pub fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T`[src]

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

#### `pub fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

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

### `impl<T> ToString for T where
T: Display + ?Sized,` [src]

#### `pub default fn to_string(&self) -> String`[src]

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

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.