Struct cap_std::net::TcpListener[−][src]

pub struct TcpListener { /* fields omitted */ }

Expand description

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

[src]

impl TcpListener

[src]

pub fn from_std(std: TcpListener, _: AmbientAuthority) -> Self

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

Ambient Authority

std::net::TcpListener is not sandboxed and may access any address that the host process has access to.

[src]

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

Returns the local socket address of this listener.

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

[src]

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.

[src]

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

Accept a new incoming connection from this listener.

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

[src]

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.

[src]

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.

[src]

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

Gets the value of the IP_TTL option for this socket.

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

[src]

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.

[src]

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

[src]

impl AsFd for TcpListener

[src]

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

Borrows the file descriptor. Read more

[src]

impl AsRawFd for TcpListener

[src]

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

[src]

impl Debug for TcpListener

[src]

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

Formats the value using the given formatter. Read more

[src]

impl FromFd for TcpListener

[src]

fn from_fd(fd: OwnedFd) -> Self

Constructs a new instance of Self from the given file descriptor. Read more

[src]

fn from_into_fd<Owned>(into_owned: Owned) -> Self where
    Owned: IntoFd,

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

[src]

impl FromRawFd for TcpListener

[src]

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor. Read more

[src]

impl IntoFd for TcpListener

[src]

fn into_fd(self) -> OwnedFd

Consumes this object, returning the underlying file descriptor. Read more

[src]

impl IntoRawFd for TcpListener

[src]

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor. Read more

[src]

impl OwnsRaw for TcpListener

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

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> AsFilelike for T where
    T: AsFd,

[src]

pub fn as_filelike(&self) -> BorrowedFd<'_>

Borrows the reference. Read more

[src]

pub fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target> where
    Target: FromFilelike + IntoFilelike,

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

[src]

impl<T> AsGrip for T where
    T: AsFd,

[src]

pub fn as_grip(&self) -> BorrowedFd<'_>

Extracts the grip.

[src]

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

[src]

pub fn as_raw_grip(&self) -> i32

Extracts the raw grip.

[src]

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

[src]

pub fn as_socketlike(&self) -> BorrowedFd<'_>

Borrows the reference.

[src]

pub fn as_socketlike_view<Target>(&self) -> FilelikeView<'_, Target> where
    Target: FromSocketlike + IntoSocketlike,

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

[src]

impl<T> AsUnsafeFile for T where
    T: AsRawFd + OwnsRaw,

[src]

pub fn as_unsafe_file(&self) -> UnsafeFile

Return the contained unsafe file.

[src]

fn as_file_view(&self) -> View<'_, File>

Utility for returning a value which dereferences to a &File or &mut File. Read more

[src]

unsafe fn as_unscoped_file_view(&self) -> View<'static, File>

Like as_file_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

[src]

fn eq_file<Filelike>(&self, other: &Filelike) -> bool where
    Filelike: AsUnsafeFile,

Test whether self.as_unsafe_file().as_unsafe_handle() is equal to other.as_unsafe_file().as_unsafe_handle(). Read more

[src]

impl<T> AsUnsafeHandle for T where
    T: AsRawFd + OwnsRaw,

[src]

pub fn as_unsafe_handle(&self) -> UnsafeHandle

Return the contained unsafe handle.

[src]

fn eq_handle<Handlelike>(&self, other: &Handlelike) -> bool where
    Handlelike: AsUnsafeHandle,

Test whether self.as_unsafe_handle() is equal to other.as_unsafe_handle(). Read more

[src]

impl<T> AsUnsafeSocket for T where
    T: AsRawFd + OwnsRaw,

[src]

pub fn as_unsafe_socket(&self) -> UnsafeSocket

Return the contained unsafe socket.

[src]

fn as_tcp_stream_view(&self) -> View<'_, TcpStream>

Utility for returning a value which dereferences to a &TcpStream or &mut TcpStream. Read more

[src]

unsafe fn as_unscoped_tcp_stream_view(&self) -> View<'static, TcpStream>

Like as_tcp_stream_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

[src]

fn as_tcp_listener_view(&self) -> View<'_, TcpListener>

Utility for returning a value which dereferences to a &TcpListener or &mut TcpListener. Read more

[src]

unsafe fn as_unscoped_tcp_listener_view(&self) -> View<'static, TcpListener>

Like as_tcp_listener_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

[src]

fn as_udp_socket_view(&self) -> View<'_, UdpSocket>

Utility for returning a value which dereferences to a &UdpSocket or &mut UdpSocket. Read more

[src]

unsafe fn as_unscoped_udp_socket_view(&self) -> View<'static, UdpSocket>

Like as_udp_socket_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

[src]

fn as_unix_stream_view(&self) -> View<'_, UnixStream>

Utility for returning a value which dereferences to a &UnixStream or &mut UnixStream. Read more

[src]

unsafe fn as_unscoped_unix_stream_view(&self) -> View<'static, UnixStream>

Like as_unix_stream_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

[src]

fn eq_socket<Socketlike>(&self, other: &Socketlike) -> bool where
    Socketlike: AsUnsafeSocket,

Test whether self.as_unsafe_socket().as_unsafe_handle() is equal to other.as_unsafe_socket().as_unsafe_handle(). Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> FromFilelike for T where
    T: FromFd,

[src]

pub fn from_filelike(owned: OwnedFd) -> T

Constructs a new instance of Self from the given filelike object. Read more

[src]

pub fn from_into_filelike<Owned>(owned: Owned) -> T where
    Owned: IntoFilelike,

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

[src]

impl<T> FromGrip for T where
    T: FromFd,

[src]

pub fn from_grip(owned_grip: OwnedFd) -> T

Consume an OwnedGrip and convert into a Self.

[src]

impl<T> FromRawGrip for T where
    T: FromRawFd,

[src]

pub unsafe fn from_raw_grip(owned_grip: i32) -> T

Consume an RawGrip and convert into a Self.

[src]

impl<T> FromSocketlike for T where
    T: FromFd,

[src]

pub fn from_socketlike(owned: OwnedFd) -> T

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

[src]

pub 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

[src]

impl<T> FromUnsafeFile for T where
    T: FromRawFd + OwnsRaw,

[src]

pub unsafe fn from_unsafe_file(unsafe_file: UnsafeFile) -> T

Convert an unsafe file into a Self. Read more

[src]

fn from_filelike<Filelike>(filelike: Filelike) -> Self where
    Filelike: IntoUnsafeFile,

Convert from a type which implements IntoUnsafeFile into a type that implements FromUnsafeFile. Read more

[src]

impl<T> FromUnsafeSocket for T where
    T: FromRawFd + OwnsRaw,

[src]

pub unsafe fn from_unsafe_socket(unsafe_socket: UnsafeSocket) -> T

Convert an unsafe socket into a Self. Read more

[src]

fn from_socketlike<Socketlike>(socketlike: Socketlike) -> Self where
    Socketlike: IntoUnsafeSocket,

Convert from a type which implements IntoUnsafeSocket into a type that implements FromUnsafeSocket. Read more

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> IntoFilelike for T where
    T: IntoFd,

[src]

pub fn into_filelike(self) -> OwnedFd

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

[src]

impl<T> IntoGrip for T where
    T: IntoFd,

[src]

pub fn into_grip(self) -> OwnedFd

Consume self and convert into an OwnedGrip.

[src]

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

[src]

pub fn into_raw_grip(self) -> i32

Consume self and convert into an RawGrip.

[src]

impl<T> IntoSocketlike for T where
    T: IntoFd,

[src]

pub fn into_socketlike(self) -> OwnedFd

Consumes this object, returning the underlying socketlike object.

[src]

impl<T> IntoUnsafeFile for T where
    T: IntoRawFd + OwnsRaw,

[src]

pub fn into_unsafe_file(self) -> UnsafeFile

Convert self into an unsafe file.

[src]

impl<T> IntoUnsafeHandle for T where
    T: IntoRawFd + OwnsRaw,

[src]

pub fn into_unsafe_handle(self) -> UnsafeHandle

Convert self into an unsafe handle.

[src]

impl<T> IntoUnsafeSocket for T where
    T: IntoRawFd + OwnsRaw,

[src]

pub fn into_unsafe_socket(self) -> UnsafeSocket

Convert self into an unsafe socket.

impl<T> SetTimes for T where
    T: AsFilelike,

pub fn set_times(
    &self, 
    atime: Option<SystemTimeSpec>, 
    mtime: Option<SystemTimeSpec>
) -> Result<(), Error>

Set the last access and last modification timestamps of an open file handle. Read more

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

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

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.