Struct UnixListener

pub struct UnixListener { /* private fields */ }

A Unix (domain) socket server, listening for incoming connections once served using one of the serve methods such as UnixListener::serve.

Note that the underlying socket (file) is only cleaned up by this listener’s Drop implementation if the listener was created using the bind_path constructor. Otherwise it is assumed that the creator of this listener is in charge of that cleanup.

Implementations

impl UnixListener

pub fn build() -> UnixListenerBuilder

Create a new UnixListenerBuilder without a state, which can be used to configure a UnixListener.

pub async fn bind_path(path: impl AsRef<Path>) -> Result<UnixListener, Error>

Creates a new UnixListener, which will be bound to the specified path.

The returned listener is ready for accepting connections.

pub fn bind_socket(socket: Socket) -> Result<UnixListener, Error>

Creates a new UnixListener, which will be bound to the specified socket.

The returned listener is ready for accepting connections.

pub async fn bind_socket_opts( opts: SocketOptions, ) -> Result<UnixListener, Box<dyn Error + Sync + Send>>

Creates a new TcpListener, which will be bound to the specified (interface) device name.

The returned listener is ready for accepting connections.

impl UnixListener

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

Returns the local address that this listener is bound to.

This can be useful, for example, when binding to port 0 to figure out which port was actually bound.

impl UnixListener

pub async fn accept(&self) -> Result<(UnixStream, UnixSocketAddress), Error>

Accept a single connection from this listener, what you can do with whatever you want.

pub async fn serve<S>(self, service: S)

where S: Service<UnixStream>,

Serve connections from this listener with the given service.

This method will block the current listener for each incoming connection, the underlying service can choose to spawn a task to handle the accepted stream.

pub async fn serve_graceful<S>(self, guard: ShutdownGuard, service: S)

where S: Service<UnixStream>,

Serve gracefully connections from this listener with the given service.

This method does the same as Self::serve but it will respect the given rama_core::graceful::ShutdownGuard, and also pass it to the service.

Trait Implementations

impl AsFd for UnixListener

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

Borrows the file descriptor.

impl AsRawFd for UnixListener

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.

impl Debug for UnixListener

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

Formats the value using the given formatter.

impl From<UnixListener> for UnixListener

fn from(value: UnixListener) -> UnixListener

Converts to this type from the input type.

impl TryFrom<Socket> for UnixListener

type Error = Error

The type returned in the event of a conversion error.

fn try_from( socket: Socket, ) -> Result<UnixListener, <UnixListener as TryFrom<Socket>>::Error>

Performs the conversion.

impl TryFrom<UnixListener> for UnixListener

type Error = Error

The type returned in the event of a conversion error.

fn try_from( listener: UnixListener, ) -> Result<UnixListener, <UnixListener as TryFrom<UnixListener>>::Error>

Performs the conversion.