Struct UnixListener 

pub struct UnixListener<S> { /* private fields */ }

Available on target_family="unix" only.

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 fn build_with_state<S>(state: S) -> UnixListenerBuilder<S>

where S: Clone + Send + Sync + 'static,

Create a new UnixListenerBuilder with the given state, which can be used to configure a UnixListener.

pub async fn bind_path(path: impl AsRef<Path>) -> Result<Self, 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<Self, 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<Self, BoxError>

Available on Android or Fuchsia or Linux only.

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

The returned listener is ready for accepting connections.

impl<S> UnixListener<S>

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

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.

pub fn state(&self) -> &S

Gets a reference to the listener’s state.

pub fn state_mut(&mut self) -> &mut S

Gets an exclusive reference to the listener’s state.

impl UnixListener<()>

pub fn with_state<S>(self, state: S) -> UnixListener<S>

Define the TcpListener’s state after it was created, useful in case it wasn’t built using the builder.

impl<State> UnixListener<State>

where State: Clone + Send + Sync + 'static,

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

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<State, 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<State, 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<S> AsFd for UnixListener<S>

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

Borrows the file descriptor.

impl<S> AsRawFd for UnixListener<S>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<S> Debug for UnixListener<S>

where S: Debug,

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

Formats the value using the given formatter.

impl From<UnixListener> for UnixListener<()>

fn from(value: TokioUnixListener) -> Self

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<Self, Self::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: StdUnixListener) -> Result<Self, Self::Error>

Performs the conversion.