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

# 1.0.0[−][src]Module std::net

Networking primitives for TCP/UDP communication.

This module provides networking functionality for the Transmission Control and User Datagram Protocols, as well as types for IP and socket addresses.

# Organization

- `TcpListener` and `TcpStream` provide functionality for communication over TCP
- `UdpSocket` provides functionality for communication over UDP
- `IpAddr` represents IP addresses of either IPv4 or IPv6; `Ipv4Addr` and `Ipv6Addr` are respectively IPv4 and IPv6 addresses
- `SocketAddr` represents socket addresses of either IPv4 or IPv6; `SocketAddrV4` and `SocketAddrV6` are respectively IPv4 and IPv6 socket addresses
- `ToSocketAddrs` is a trait that used for generic address resolution when interacting with networking objects like `TcpListener`, `TcpStream` or `UdpSocket`
- Other types are return or parameter types for various methods in this module

## Structs

AddrParseError | An error which can be returned when parsing an IP address or a socket address.
Incoming | An iterator that infinitely `accept`s connections on a `TcpListener`.
Ipv4Addr | An IPv4 address.
Ipv6Addr | An IPv6 address.
SocketAddrV4 | An IPv4 socket address.
SocketAddrV6 | An IPv6 socket address.
TcpListener | A TCP socket server, listening for connections.
TcpStream | A TCP stream between a local and a remote socket.
UdpSocket | A UDP socket.

## Enums

IpAddr | An IP address, either IPv4 or IPv6.
Shutdown | Possible values which can be passed to the `shutdown` method of `TcpStream`.
SocketAddr | An internet socket address, either IPv4 or IPv6.
Ipv6MulticastScope | [ Experimental ]

## Traits

ToSocketAddrs | A trait for objects which can be converted or resolved to one or more `SocketAddr` values.

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