Struct cap_std::net::TcpListener

pub struct TcpListener { /* fields omitted */ }

A TCP socket server, listening for connections.

This corresponds to std::net::TcpListener.

Note that this TcpListener has no bind method. To bind it to a socket address, you must first obtain a Pool permitting the address, and then call Pool::bind_tcp_listener.

Implementations

impl TcpListener

pub fn from_std(std: TcpListener) -> Self

Constructs a new instance of Self from the given std::net::TcpListener.

This grants access the resources the std::net::TcpListener instance already has access to.

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

Returns the local socket address of this listener.

This corresponds to std::net::TcpListener::local_addr.

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

Creates a new independently owned handle to the underlying socket.

This corresponds to std::net::TcpListener::try_clone.

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

Accept a new incoming connection from this listener.

This corresponds to std::net::TcpListener::accept.

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

Returns an iterator over the connections being received on this listener.

This corresponds to std::net::TcpListener::incoming.

pub fn set_ttl(&self, ttl: u32) -> Result<()>

Sets the value for the IP_TTL option on this socket.

This corresponds to std::net::TcpListener::set_ttl.

pub fn ttl(&self) -> Result<u32>

Gets the value of the IP_TTL option for this socket.

This corresponds to std::net::TcpListener::ttl.

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

Gets the value of the SO_ERROR option on this socket.

This corresponds to std::net::TcpListener::take_error.

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

Moves this TCP stream into or out of nonblocking mode.

This corresponds to std::net::TcpListener::set_nonblocking.

Trait Implementations

impl AsRawHandleOrSocket for TcpListener

fn as_raw_handle_or_socket(&self) -> RawHandleOrSocket

Like AsRawHandle::as_raw_handle and AsRawSocket::as_raw_socket but can return either type.

impl AsRawSocket for TcpListener

fn as_raw_socket(&self) -> RawSocket

Extracts the underlying raw socket from this object.

impl AsSocket for TcpListener

fn as_socket(&self) -> BorrowedSocket<'_>

Borrows the socket.

impl Debug for TcpListener

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

Formats the value using the given formatter.

impl FromRawSocket for TcpListener

unsafe fn from_raw_socket(socket: RawSocket) -> Self

Creates a new I/O object from the given raw socket.

impl FromSocket for TcpListener

fn from_socket(socket: OwnedSocket) -> Self

Constructs a new instance of Self from the given socket.

fn from_into_socket<Owned>(into_owned: Owned) -> Self where
    Owned: IntoSocket, 

Constructs a new instance of Self from the given socket converted from into_owned.

impl IntoRawHandleOrSocket for TcpListener

fn into_raw_handle_or_socket(self) -> RawHandleOrSocket

Like IntoRawHandle::into_raw_handle and IntoRawSocket::into_raw_socket but can return either type.

impl IntoRawSocket for TcpListener

fn into_raw_socket(self) -> RawSocket

Consumes this object, returning the raw underlying socket.

impl IntoSocket for TcpListener

fn into_socket(self) -> OwnedSocket

Consumes this object, returning the underlying socket.