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

    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.

## Methods

### `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};

    fn main() {
        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};

    fn main() {
        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 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

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

### `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 Eq for SocketAddr`[src]

### `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<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 Debug for SocketAddr`[src]

#### `fn fmt(&self, f: &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 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

#### `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 Clone for SocketAddr`[src]

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

Returns a copy of the value. Read more

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

Performs copy-assignment from `source`. Read more

## Auto Trait Implementations

### `impl Send for SocketAddr`

### `impl Sync for SocketAddr`

## Blanket Implementations

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

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

Performs the conversion.

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

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

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

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

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

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

Performs the conversion.

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

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

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

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

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

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

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

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

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

#### `type Owned = T`

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

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

#### `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]

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

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

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)