Struct cap_std::net::TcpListener
source · [−]pub struct TcpListener { /* private fields */ }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
sourceimpl TcpListener
impl TcpListener
sourcepub fn from_std(std: TcpListener) -> Self
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.
sourcepub fn local_addr(&self) -> Result<SocketAddr>
pub fn local_addr(&self) -> Result<SocketAddr>
Returns the local socket address of this listener.
This corresponds to std::net::TcpListener::local_addr.
sourcepub fn try_clone(&self) -> Result<Self>
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.
sourcepub fn accept(&self) -> Result<(TcpStream, SocketAddr)>
pub fn accept(&self) -> Result<(TcpStream, SocketAddr)>
Accept a new incoming connection from this listener.
This corresponds to std::net::TcpListener::accept.
sourcepub fn incoming(&self) -> Incoming<'_>ⓘNotable traits for Incoming<'a>impl<'a> Iterator for Incoming<'a> type Item = Result<TcpStream>;
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.
sourcepub fn set_ttl(&self, ttl: u32) -> Result<()>
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.
sourcepub fn ttl(&self) -> Result<u32>
pub fn ttl(&self) -> Result<u32>
Gets the value of the IP_TTL option for this socket.
This corresponds to std::net::TcpListener::ttl.
sourcepub fn take_error(&self) -> Result<Option<Error>>
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.
sourcepub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>
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
sourceimpl AsRawHandleOrSocket for TcpListener
Available on Windows only.
impl AsRawHandleOrSocket for TcpListener
sourcefn as_raw_handle_or_socket(&self) -> RawHandleOrSocket
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
sourceimpl AsRawSocket for TcpListener
Available on Windows only.
impl AsRawSocket for TcpListener
sourcefn as_raw_socket(&self) -> RawSocket
fn as_raw_socket(&self) -> RawSocket
Extracts the raw socket. Read more
sourceimpl AsSocket for TcpListener
Available on Windows only.
impl AsSocket for TcpListener
sourcefn as_socket(&self) -> BorrowedSocket<'_>
fn as_socket(&self) -> BorrowedSocket<'_>
Borrows the socket.
sourceimpl Debug for TcpListener
impl Debug for TcpListener
sourceimpl FromRawSocket for TcpListener
Available on Windows only.
impl FromRawSocket for TcpListener
sourceunsafe fn from_raw_socket(socket: RawSocket) -> Self
unsafe fn from_raw_socket(socket: RawSocket) -> Self
Constructs a new I/O object from the specified raw socket. Read more
sourceimpl FromSocket for TcpListener
Available on Windows only.
impl FromSocket for TcpListener
sourcefn from_socket(socket: OwnedSocket) -> Self
fn from_socket(socket: OwnedSocket) -> Self
Constructs a new instance of Self from the given socket.
sourcefn from_into_socket<Owned>(into_owned: Owned) -> Self where
Owned: IntoSocket,
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. Read more
sourceimpl IntoRawHandleOrSocket for TcpListener
Available on Windows only.
impl IntoRawHandleOrSocket for TcpListener
sourcefn into_raw_handle_or_socket(self) -> RawHandleOrSocket
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
sourceimpl IntoRawSocket for TcpListener
Available on Windows only.
impl IntoRawSocket for TcpListener
sourcefn into_raw_socket(self) -> RawSocket
fn into_raw_socket(self) -> RawSocket
Consumes this object, returning the raw underlying socket. Read more
sourceimpl IntoSocket for TcpListener
Available on Windows only.
impl IntoSocket for TcpListener
sourcefn into_socket(self) -> OwnedSocket
fn into_socket(self) -> OwnedSocket
Consumes this object, returning the underlying socket.
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
sourceimpl<T> AsRawGrip for T where
T: AsRawHandleOrSocket,
impl<T> AsRawGrip for T where
T: AsRawHandleOrSocket,
sourcefn as_raw_grip(&self) -> RawHandleOrSocket
fn as_raw_grip(&self) -> RawHandleOrSocket
Extracts the raw grip.
sourceimpl<T> AsRawSocketlike for T where
T: AsRawSocket,
impl<T> AsRawSocketlike for T where
T: AsRawSocket,
sourcefn as_raw_socketlike(&self) -> u32
fn as_raw_socketlike(&self) -> u32
Returns the raw value.
sourceimpl<T> AsSocketlike for T where
T: AsSocket,
impl<T> AsSocketlike for T where
T: AsSocket,
sourcefn as_socketlike(&self) -> BorrowedSocket<'_>
fn as_socketlike(&self) -> BorrowedSocket<'_>
Borrows the reference.
sourcefn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target> where
Target: SocketlikeViewType,
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> FromRawSocketlike for T where
T: FromRawSocket,
impl<T> FromRawSocketlike for T where
T: FromRawSocket,
sourceunsafe fn from_raw_socketlike(raw: u32) -> T
unsafe fn from_raw_socketlike(raw: u32) -> T
Constructs Self from the raw value.
sourceimpl<T> FromSocketlike for T where
T: FromSocket,
impl<T> FromSocketlike for T where
T: FromSocket,
sourcefn from_socketlike(owned: OwnedSocket) -> T
fn from_socketlike(owned: OwnedSocket) -> T
Constructs a new instance of Self from the given socketlike object.
sourcefn from_into_socketlike<Owned>(owned: Owned) -> T where
Owned: IntoSocketlike,
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
sourceimpl<T> IntoRawGrip for T where
T: IntoRawHandleOrSocket,
impl<T> IntoRawGrip for T where
T: IntoRawHandleOrSocket,
sourcefn into_raw_grip(self) -> RawHandleOrSocket
fn into_raw_grip(self) -> RawHandleOrSocket
Consume self and convert into an RawGrip.
sourceimpl<T> IntoRawSocketlike for T where
T: IntoRawSocket,
impl<T> IntoRawSocketlike for T where
T: IntoRawSocket,
sourcefn into_raw_socketlike(self) -> u32
fn into_raw_socketlike(self) -> u32
Returns the raw value.
sourceimpl<T> IntoSocketlike for T where
T: IntoSocket,
impl<T> IntoSocketlike for T where
T: IntoSocket,
sourcefn into_socketlike(self) -> OwnedSocket
fn into_socketlike(self) -> OwnedSocket
Consumes this object, returning the underlying socketlike object. Read more