Struct socket2::Socket

source ·

pub struct Socket { /* private fields */ }

Expand description

Owned wrapper around a system socket.

This type simply wraps an instance of a file descriptor (c_int) on Unix and an instance of SOCKET on Windows. This is the main type exported by this crate and is intended to mirror the raw semantics of sockets on platforms as closely as possible. Almost all methods correspond to precisely one libc or OS API call which is essentially just a “Rustic translation” of what’s below.

§Converting to and from other types

This type can be freely converted into the network primitives provided by the standard library, such as TcpStream or UdpSocket, using the From trait, see the example below.

§Notes

Some methods that set options on Socket require two system calls to set their options without overwriting previously set options. We do this by first getting the current settings, applying the desired changes, and then updating the settings. This means that the operation is not atomic. This can lead to a data race when two threads are changing options in parallel.

§Examples

use std::net::{SocketAddr, TcpListener};
use socket2::{Socket, Domain, Type};

// create a TCP listener
let socket = Socket::new(Domain::IPV6, Type::STREAM, None)?;

let address: SocketAddr = "[::1]:12345".parse().unwrap();
let address = address.into();
socket.bind(&address)?;
socket.listen(128)?;

let listener: TcpListener = socket.into();
// ...

Struct socket2::SocketCopy item path

§Converting to and from other types

§Notes

§Examples

Implementations§

impl Socket

pub fn new( domain: Domain, ty: Type, protocol: Option<Protocol>, ) -> Result<Socket>

pub fn new_raw( domain: Domain, ty: Type, protocol: Option<Protocol>, ) -> Result<Socket>

pub fn pair( domain: Domain, ty: Type, protocol: Option<Protocol>, ) -> Result<(Socket, Socket)>

pub fn pair_raw( domain: Domain, ty: Type, protocol: Option<Protocol>, ) -> Result<(Socket, Socket)>

pub fn bind(&self, address: &SockAddr) -> Result<()>

pub fn connect(&self, address: &SockAddr) -> Result<()>

§Notes

pub fn connect_timeout(&self, addr: &SockAddr, timeout: Duration) -> Result<()>

§Warnings

pub fn listen(&self, backlog: c_int) -> Result<()>

pub fn accept(&self) -> Result<(Socket, SockAddr)>

pub fn accept_raw(&self) -> Result<(Socket, SockAddr)>

pub fn local_addr(&self) -> Result<SockAddr>

§Notes

pub fn peer_addr(&self) -> Result<SockAddr>

§Notes

pub fn type(&self) -> Result<Type>

pub fn try_clone(&self) -> Result<Socket>

§Notes

pub fn nonblocking(&self) -> Result<bool>

§Notes

pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>

§Notes

pub fn shutdown(&self, how: Shutdown) -> Result<()>

pub fn recv(&self, buf: &mut [MaybeUninit<u8>]) -> Result<usize>

§Safety

pub fn recv_out_of_band(&self, buf: &mut [MaybeUninit<u8>]) -> Result<usize>

pub fn recv_with_flags( &self, buf: &mut [MaybeUninit<u8>], flags: c_int, ) -> Result<usize>

pub fn recv_vectored( &self, bufs: &mut [MaybeUninitSlice<'_>], ) -> Result<(usize, RecvFlags)>

§Safety

pub fn recv_vectored_with_flags( &self, bufs: &mut [MaybeUninitSlice<'_>], flags: c_int, ) -> Result<(usize, RecvFlags)>

§Safety

pub fn peek(&self, buf: &mut [MaybeUninit<u8>]) -> Result<usize>

§Safety

pub fn recv_from( &self, buf: &mut [MaybeUninit<u8>], ) -> Result<(usize, SockAddr)>

§Safety

pub fn recv_from_with_flags( &self, buf: &mut [MaybeUninit<u8>], flags: c_int, ) -> Result<(usize, SockAddr)>

pub fn recv_from_vectored( &self, bufs: &mut [MaybeUninitSlice<'_>], ) -> Result<(usize, RecvFlags, SockAddr)>

§Safety

pub fn recv_from_vectored_with_flags( &self, bufs: &mut [MaybeUninitSlice<'_>], flags: c_int, ) -> Result<(usize, RecvFlags, SockAddr)>

§Safety

pub fn peek_from( &self, buf: &mut [MaybeUninit<u8>], ) -> Result<(usize, SockAddr)>

§Safety

§Note: Datagram Sockets

pub fn peek_sender(&self) -> Result<SockAddr>

pub fn recvmsg( &self, msg: &mut MsgHdrMut<'_, '_, '_>, flags: c_int, ) -> Result<usize>

pub fn send(&self, buf: &[u8]) -> Result<usize>

pub fn send_with_flags(&self, buf: &[u8], flags: c_int) -> Result<usize>

pub fn send_vectored(&self, bufs: &[IoSlice<'_>]) -> Result<usize>

pub fn send_vectored_with_flags( &self, bufs: &[IoSlice<'_>], flags: c_int, ) -> Result<usize>

pub fn send_out_of_band(&self, buf: &[u8]) -> Result<usize>

pub fn send_to(&self, buf: &[u8], addr: &SockAddr) -> Result<usize>

pub fn send_to_with_flags( &self, buf: &[u8], addr: &SockAddr, flags: c_int, ) -> Result<usize>

pub fn send_to_vectored( &self, bufs: &[IoSlice<'_>], addr: &SockAddr, ) -> Result<usize>

pub fn send_to_vectored_with_flags( &self, bufs: &[IoSlice<'_>], addr: &SockAddr, flags: c_int, ) -> Result<usize>

pub fn sendmsg(&self, msg: &MsgHdr<'_, '_, '_>, flags: c_int) -> Result<usize>

impl Socket

pub fn broadcast(&self) -> Result<bool>

pub fn set_broadcast(&self, broadcast: bool) -> Result<()>

pub fn take_error(&self) -> Result<Option<Error>>

pub fn keepalive(&self) -> Result<bool>

pub fn set_keepalive(&self, keepalive: bool) -> Result<()>

pub fn linger(&self) -> Result<Option<Duration>>

pub fn set_linger(&self, linger: Option<Duration>) -> Result<()>

§Notes

pub fn out_of_band_inline(&self) -> Result<bool>

pub fn set_out_of_band_inline(&self, oob_inline: bool) -> Result<()>

pub fn passcred(&self) -> Result<bool>

pub fn set_passcred(&self, passcred: bool) -> Result<()>

pub fn recv_buffer_size(&self) -> Result<usize>

pub fn set_recv_buffer_size(&self, size: usize) -> Result<()>

pub fn read_timeout(&self) -> Result<Option<Duration>>

pub fn set_read_timeout(&self, duration: Option<Duration>) -> Result<()>

pub fn reuse_address(&self) -> Result<bool>

Struct socket2::Socket