Module 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.

This module is an async version of std::net.

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

Platform-specific extensions

APIs such as Unix domain sockets are available on certain platforms only. You can find platform-specific extensions in the async_std::os module.

Examples

A simple UDP echo server:

use async_std::net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:8080").await?;
let mut buf = vec![0u8; 1024];

loop {
    let (n, peer) = socket.recv_from(&mut buf).await?;
    socket.send_to(&buf[..n], &peer).await?;
}

Structs

AddrParseError

An error which can be returned when parsing an IP address or a socket address.

Incoming

A stream of incoming TCP connections.

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 TcpStream::shutdown method.

SocketAddr

An internet socket address, either IPv4 or IPv6.

Traits

ToSocketAddrs

Converts or resolves addresses to SocketAddr values.