Struct cap_std::net::TcpListener

source · [−]

pub struct TcpListener { /* private fields */ }

Available on non-WASI only.

Expand description

A TCP socket server, listening for connections.

This corresponds to std::net::TcpListener.

This TcpListener has no bind method. To bind it to a socket address, first obtain a Pool permitting the address, and then call Pool::bind_tcp_listener.

Implementations

source

impl TcpListener

source

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.

source

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

Returns the local socket address of this listener.

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

source

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.

source

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

Accept a new incoming connection from this listener.

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

source

pub fn incoming(&self) -> Incoming<'_>ⓘNotable traits for Incoming<'a>`impl<'a> Iterator for Incoming<'a> type Item = Result<TcpStream>;`

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

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

source

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.

source

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

Gets the value of the IP_TTL option for this socket.

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

source

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.

source

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

source

impl AsRawHandleOrSocket for TcpListener

Available on Windows only.

source

fn as_raw_handle_or_socket(&self) -> RawHandleOrSocket

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

source

impl AsRawSocket for TcpListener

Available on Windows only.

source

fn as_raw_socket(&self) -> RawSocket

Extracts the raw socket. Read more

source

impl AsSocket for TcpListener

Available on Windows only.

source

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

Borrows the socket.

source

impl Debug for TcpListener

source

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

Formats the value using the given formatter. Read more

source

impl From<OwnedSocket> for TcpListener

Available on Windows only.

source

fn from(socket: OwnedSocket) -> Self

Converts to this type from the input type.

source

impl From<TcpListener> for OwnedSocket

Available on Windows only.

source

fn from(listener: TcpListener) -> OwnedSocket

Converts to this type from the input type.

source

impl FromRawSocket for TcpListener

Available on Windows only.

source

unsafe fn from_raw_socket(socket: RawSocket) -> Self

Constructs a new I/O object from the specified raw socket. Read more

source

impl IntoRawHandleOrSocket for TcpListener

Available on Windows only.

source

fn into_raw_handle_or_socket(self) -> RawHandleOrSocket

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

source

impl IntoRawSocket for TcpListener

Available on Windows only.

source

fn into_raw_socket(self) -> RawSocket

Consumes this object, returning the raw underlying socket. Read more

Auto Trait Implementations

impl RefUnwindSafe for TcpListener

impl Send for TcpListener

impl Sync for TcpListener

impl Unpin for TcpListener

impl UnwindSafe for TcpListener

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> AsRawGrip for T where
T: AsRawHandleOrSocket,

source

fn as_raw_grip(&self) -> RawHandleOrSocket

Extracts the raw grip.

source

impl<T> AsRawSocketlike for T where
T: AsRawSocket,

source

fn as_raw_socketlike(&self) -> u32

Returns the raw value.

source

impl<T> AsSocketlike for T where
T: AsSocket,

source

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

Borrows the reference.

source

fn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target> where
Target: SocketlikeViewType,

Return a borrowing view of a resource which dereferences to a &Target. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> FromRawSocketlike for T where
T: FromRawSocket,

source

unsafe fn from_raw_socketlike(raw: u32) -> T

Constructs Self from the raw value.

source

impl<T> FromSocket for T where
T: From<OwnedSocket>,

source

fn from_socket(owned_socket: OwnedSocket) -> T

👎Deprecated since 1.0.0:

FromSocket::from_socket is replaced by From<OwnedSocket>::from

Constructs a new instance of Self from the given socket.

source

fn from_into_socket<Owned>(into_owned: Owned) -> Self where
Owned: Into<OwnedSocket>,
Self: From<OwnedSocket>,

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

source

impl<T> FromSocketlike for T where
T: From<OwnedSocket>,

source

fn from_socketlike(owned: OwnedSocket) -> T

Constructs a new instance of Self from the given socketlike object.

source

fn from_into_socketlike<Owned>(owned: Owned) -> T where
Owned: IntoSocketlike,

Constructs a new instance of Self from the given socketlike object converted from into_owned. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> IntoRawGrip for T where
T: IntoRawHandleOrSocket,

source

fn into_raw_grip(self) -> RawHandleOrSocket

Consume self and convert into an RawGrip.

source

impl<T> IntoRawSocketlike for T where
T: IntoRawSocket,

source

fn into_raw_socketlike(self) -> u32

Returns the raw value.

source

impl<T> IntoSocket for T where
OwnedSocket: From<T>,

source

fn into_socket(self) -> OwnedSocket

👎Deprecated since 1.0.0:

IntoSocket is replaced by From<...> for OwnedSocket or Into<OwnedSocket>

Consumes this object, returning the underlying socket.

source

impl<T> IntoSocketlike for T where
T: Into<OwnedSocket>,

source

fn into_socketlike(self) -> OwnedSocket

Consumes this object, returning the underlying socketlike object. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct cap_std::net::TcpListener

Implementations

impl TcpListener

pub fn from_std(std: TcpListener) -> Self

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

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

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

pub fn incoming(&self) -> Incoming<'_>ⓘNotable traits for Incoming<'a>impl<'a> Iterator for Incoming<'a> type Item = Result<TcpStream>;

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

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

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

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

Trait Implementations

impl AsRawHandleOrSocket for TcpListener

fn as_raw_handle_or_socket(&self) -> RawHandleOrSocket

impl AsRawSocket for TcpListener

fn as_raw_socket(&self) -> RawSocket

impl AsSocket for TcpListener

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

impl Debug for TcpListener

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

impl From<OwnedSocket> for TcpListener

fn from(socket: OwnedSocket) -> Self

impl From<TcpListener> for OwnedSocket

fn from(listener: TcpListener) -> OwnedSocket

impl FromRawSocket for TcpListener

unsafe fn from_raw_socket(socket: RawSocket) -> Self

impl IntoRawHandleOrSocket for TcpListener

fn into_raw_handle_or_socket(self) -> RawHandleOrSocket

impl IntoRawSocket for TcpListener

fn into_raw_socket(self) -> RawSocket

Auto Trait Implementations

impl RefUnwindSafe for TcpListener

impl Send for TcpListener

impl Sync for TcpListener

impl Unpin for TcpListener

impl UnwindSafe for TcpListener

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> AsRawGrip for T where T: AsRawHandleOrSocket,

fn as_raw_grip(&self) -> RawHandleOrSocket

impl<T> AsRawSocketlike for T where T: AsRawSocket,

fn as_raw_socketlike(&self) -> u32

impl<T> AsSocketlike for T where T: AsSocket,

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

fn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target> where Target: SocketlikeViewType,

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FromRawSocketlike for T where T: FromRawSocket,

unsafe fn from_raw_socketlike(raw: u32) -> T

impl<T> FromSocket for T where T: From<OwnedSocket>,

fn from_socket(owned_socket: OwnedSocket) -> T

fn from_into_socket<Owned>(into_owned: Owned) -> Self where Owned: Into<OwnedSocket>, Self: From<OwnedSocket>,

impl<T> FromSocketlike for T where T: From<OwnedSocket>,

fn from_socketlike(owned: OwnedSocket) -> T

fn from_into_socketlike<Owned>(owned: Owned) -> T where Owned: IntoSocketlike,

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> IntoRawGrip for T where T: IntoRawHandleOrSocket,

fn into_raw_grip(self) -> RawHandleOrSocket

impl<T> IntoRawSocketlike for T where T: IntoRawSocket,

fn into_raw_socketlike(self) -> u32

impl<T> IntoSocket for T where OwnedSocket: From<T>,

fn into_socket(self) -> OwnedSocket

impl<T> IntoSocketlike for T where T: Into<OwnedSocket>,

fn into_socketlike(self) -> OwnedSocket

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn incoming(&self) -> Incoming<'_>ⓘNotable traits for Incoming<'a>`impl<'a> Iterator for Incoming<'a> type Item = Result<TcpStream>;`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> AsRawGrip for T where
T: AsRawHandleOrSocket,

impl<T> AsRawSocketlike for T where
T: AsRawSocket,

impl<T> AsSocketlike for T where
T: AsSocket,

fn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target> where
Target: SocketlikeViewType,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> FromRawSocketlike for T where
T: FromRawSocket,

impl<T> FromSocket for T where
T: From<OwnedSocket>,

fn from_into_socket<Owned>(into_owned: Owned) -> Self where
Owned: Into<OwnedSocket>,
Self: From<OwnedSocket>,

impl<T> FromSocketlike for T where
T: From<OwnedSocket>,

fn from_into_socketlike<Owned>(owned: Owned) -> T where
Owned: IntoSocketlike,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> IntoRawGrip for T where
T: IntoRawHandleOrSocket,

impl<T> IntoRawSocketlike for T where
T: IntoRawSocket,

impl<T> IntoSocket for T where
OwnedSocket: From<T>,

impl<T> IntoSocketlike for T where
T: Into<OwnedSocket>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,