std::net::SocketAddr - Rust
Description: API documentation for the Rust `SocketAddr` enum in crate `std`.
Keywords: rust, rustlang, rust-lang, SocketAddr

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

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

Representation of a socket address for networking applications.

A socket address can either represent the IPv4 or IPv6 protocol and is paired with at least a port number as well. Each protocol may have more specific information about the address available to it as well.

## Variants

`V4(SocketAddrV4)`

An IPv4 socket address which is a (ip, port) combination.

`V6(SocketAddrV6)`

An IPv6 socket address.

## Methods

### `impl SocketAddr`
[src]

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

Creates a new socket address from the (ip, port) pair.

# 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

#### `fn ip(&self) -> IpAddr`
1.7.0

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

#### `fn set_ip(&mut self, new_ip: IpAddr)`
1.9.0

Change 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

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

#### `fn set_port(&mut self, new_port: u16)`
1.9.0

Change 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

#### `fn is_ipv4(&self) -> bool`
1.16.0

Returns true if the IP in this `SocketAddr` is a valid IPv4 address, false if it's a valid IPv6 address.

# 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

#### `fn is_ipv6(&self) -> bool`
1.16.0

Returns true if the IP in this `SocketAddr` is a valid IPv6 address, false if it's a valid IPv4 address.

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

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

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

Returns a copy of the value. Read more

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

Performs copy-assignment from `source`. Read more

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

#### `fn eq(&self, __arg_0: &SocketAddr) -> bool`

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

#### `fn ne(&self, __arg_0: &SocketAddr) -> bool`

This method tests for `!=`.

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

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

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

Feeds this value into the state given, updating the hasher as necessary.

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

Feeds a slice of this type into the state provided.

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

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result`

Formats the value using the given formatter.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

#### `fn fmt(&self, f: &mut Formatter) -> Result`

Formats the value using the given formatter.

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

Converts this object to an iterator of resolved `SocketAddr`s. 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>`

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

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand 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`)