Struct UnixSocket 

pub struct UnixSocket { /* private fields */ }

A Unix domain socket, of streams or of datagrams, to bind before it connects, listens or sends.

use nuclei::net::UnixSocket;

let dir = std::env::temp_dir().join(format!("nuclei-doc-unix-socket-{}", std::process::id()));
let _ = std::fs::remove_file(&dir);
let listener = UnixSocket::new_stream()?;
listener.bind(&dir)?;
let listener = listener.listen(16)?;
let client = UnixSocket::new_stream()?.connect(&dir).await?;
let (_server, _) = listener.accept().await?;
client.send(b"hi").await?;
std::fs::remove_file(&dir)?;

Implementations

impl UnixSocket

pub fn new_stream() -> Result<UnixSocket>

A new socket of streams.

Errors

When the system has no socket to give.

pub fn new_datagram() -> Result<UnixSocket>

A new socket of datagrams.

Errors

When the system has no socket to give.

pub fn bind(&self, path: impl AsRef<Path>) -> Result<()>

Binds the socket to path, which must not exist yet.

Errors

As bind(2): the path exists, or is too long.

pub fn listen(self, backlog: u32) -> Result<UnixListener>

Makes a socket of streams a listener, with room for backlog connections not accepted yet.

Errors

On a socket of datagrams, and as listen(2).

pub async fn connect(self, path: impl AsRef<Path>) -> Result<UnixStream>

Connects a socket of streams to the listener at path.

Errors

On a socket of datagrams, and as connect(2).

pub fn datagram(self) -> Result<UnixDatagram>

Makes a socket of datagrams a datagram socket, bound or not.

Errors

On a socket of streams.

Trait Implementations

impl AsFd for UnixSocket

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for UnixSocket

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for UnixSocket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromRawFd for UnixSocket

unsafe fn from_raw_fd(fd: RawFd) -> UnixSocket

Safety

fd is an open, non-blocking Unix domain socket the caller owns and hands over.

impl IntoRawFd for UnixSocket

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.