Struct cap_std::os::unix::net::UnixListener

pub struct UnixListener { /* private fields */ }

Available on Unix only.

A structure representing a Unix domain socket server.

This corresponds to std::os::unix::net::UnixListener.

This UnixListener has no bind method. To bind it to a socket address, first obtain a Dir containing the path, and then call Dir::bind_unix_listener.

Implementations

impl UnixListener

pub fn from_std(std: UnixListener) -> Self

Constructs a new instance of Self from the given std::os::unix::net::UnixListener.

This grants access the resources the std::os::unix::net::UnixListener instance already has access to.

pub fn accept(&self) -> Result<(UnixStream, SocketAddr)>

Accepts a new incoming connection to this listener.

This corresponds to std::os::unix::net::UnixListener::accept.

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

Creates a new independently owned handle to the underlying socket.

This corresponds to std::os::unix::net::UnixListener::try_clone.

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

Returns the local socket address of this listener.

This corresponds to std::os::unix::net::UnixListener::local_addr.

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

Moves the socket into or out of nonblocking mode.

This corresponds to std::os::unix::net::UnixListener::set_nonblocking.

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

Returns the value of the SO_ERROR option.

This corresponds to std::os::unix::net::UnixListener::take_error.

pub fn incoming(&self) -> Incoming<'_>

Returns an iterator over incoming connections.

This corresponds to std::os::unix::net::UnixListener::incoming.

Trait Implementations

impl AsFd for UnixListener

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

Borrows the file descriptor.

impl AsRawFd for UnixListener

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for UnixListener

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

Formats the value using the given formatter.

impl From<OwnedFd> for UnixListener

fn from(fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<UnixListener> for OwnedFd

fn from(listener: UnixListener) -> OwnedFd

Converts to this type from the input type.

impl FromRawFd for UnixListener

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl<'a> IntoIterator for &'a UnixListener

type IntoIter = Incoming<'a>

Which kind of iterator are we turning this into?

type Item = Result<UnixStream, Error>

The type of the elements being iterated over.

fn into_iter(self) -> Incoming<'a>

Creates an iterator from a value.

impl IntoRawFd for UnixListener

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.