Struct PollFd &nbsp; Copy item path

impl<T> PollFd<T>
where T: AsFd,

pub fn new(source: T) -> Result<PollFd<T>, Error>

Available on crate feature net only.

Create PollFd without attaching the source.

Ready-based sources does not need to be attached.

pub fn from_shared_fd(inner: SharedFd<T>) -> Result<PollFd<T>, Error>

Available on crate feature net only.

Create PollFd from a shared file descriptor.

impl<T> PollFd<T>
where T: AsFd + 'static,

pub async fn accept(&self) -> Result<(PollFd<Socket>, SockAddr), Error>

Available on crate feature net only.

Accept a connection from this socket.

pub fn poll_accept( &self, cx: &mut Context<'_>, ) -> Poll<Result<(PollFd<Socket>, SockAddr), Error>>

Available on crate feature net only.

Poll to accept a connection from this socket.

pub async fn connect(&self, addr: &SockAddr) -> Result<(), Error>

Available on crate feature net only.

Connect this socket to the specified address.

pub async fn accept_ready(&self) -> Result<(), Error>

Available on crate feature net only.

Wait for accept readiness, before calling accept, or after accept returns WouldBlock.

pub async fn connect_ready(&self) -> Result<(), Error>

Available on crate feature net only.

Wait for connect readiness.

pub async fn read_ready(&self) -> Result<(), Error>

Available on crate feature net only.

Wait for read readiness.

pub async fn write_ready(&self) -> Result<(), Error>

Available on crate feature net only.

Wait for write readiness.

pub fn poll_accept_ready(&self, cx: &mut Context<'_>) -> Poll<Result<(), Error>>

Available on crate feature net only.

Poll for accept readiness.

pub fn poll_connect_ready( &self, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Available on crate feature net only.

Poll for connect readiness.

pub fn poll_read_ready(&self, cx: &mut Context<'_>) -> Poll<Result<(), Error>>

Available on crate feature net only.

Poll for read readiness.

pub fn poll_write_ready(&self, cx: &mut Context<'_>) -> Poll<Result<(), Error>>

Available on crate feature net only.

Poll for write readiness.

pub fn poll_accept_with<R>( &self, cx: &mut Context<'_>, f: impl FnMut(&T) -> Result<R, Error>, ) -> Poll<Result<R, Error>>

Available on crate feature net only.

Poll for accept readiness and call the provided function.

pub fn poll_read_with<R>( &self, cx: &mut Context<'_>, f: impl FnMut(&T) -> Result<R, Error>, ) -> Poll<Result<R, Error>>

Available on crate feature net only.

Poll for read readiness and call the provided function.

pub fn poll_write_with<R>( &self, cx: &mut Context<'_>, f: impl FnMut(&T) -> Result<R, Error>, ) -> Poll<Result<R, Error>>

Available on crate feature net only.

Poll for write readiness and call the provided function.

impl<T> PollFd<T>
where T: AsFd + 'static,

pub fn poll_read( &self, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize, Error>>

Available on crate feature net only.

Poll for read readiness and read data.

pub fn poll_read_vectored( &self, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Available on crate feature net only.

Poll for read readiness and read data into a slice of buffers.

pub fn poll_read_buf( &self, cx: &mut Context<'_>, buf: BorrowedCursor<'_, u8>, ) -> Poll<Result<(), Error>>

Available on crate features net and read_buf only.

Poll for read readiness and read data into an uninitialized buffer.

impl<T> PollFd<T>
where T: AsFd + 'static,

pub fn poll_write( &self, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Available on crate feature net only.

Poll for write readiness and write data.

pub fn poll_write_vectored( &self, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Available on crate feature net only.

Poll for write readiness and write data from a slice of buffers.

Whether this is more efficient than poll_write depends on the source: it is a single writev for sockets and files, while other sources may fall back to writing the first non-empty buffer.

pub fn poll_flush(&self, _cx: &mut Context<'_>) -> Poll<Result<(), Error>>

Available on crate feature net only.

Flush pending writes.

PollFd does not buffer writes, so this is a no-op.

Trait Implementations§

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

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

Borrows the file descriptor. Read more

impl<T> AsRawFd for PollFd<T>
where T: AsFd,

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor. Read more

impl<T> AsyncRead for &PollFd<T>
where T: AsFd + 'static,

fn poll_read( self: Pin<&mut &PollFd<T>>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf. Read more

fn poll_read_vectored( self: Pin<&mut &PollFd<T>>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations. Read more

impl<T> AsyncRead for PollFd<T>
where T: AsFd + 'static,

fn poll_read( self: Pin<&mut PollFd<T>>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf. Read more

fn poll_read_vectored( self: Pin<&mut PollFd<T>>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations. Read more

impl<T> AsyncWrite for &PollFd<T>
where T: AsFd + 'static,

fn poll_write( self: Pin<&mut &PollFd<T>>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object. Read more

fn poll_write_vectored( self: Pin<&mut &PollFd<T>>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations. Read more

fn poll_flush( self: Pin<&mut &PollFd<T>>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination. Read more

fn poll_close( self: Pin<&mut &PollFd<T>>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempt to close the object. Read more

impl<T> AsyncWrite for PollFd<T>
where T: AsFd + 'static,

fn poll_write( self: Pin<&mut PollFd<T>>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object. Read more

fn poll_write_vectored( self: Pin<&mut PollFd<T>>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations. Read more

fn poll_flush( self: Pin<&mut PollFd<T>>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination. Read more

fn poll_close( self: Pin<&mut PollFd<T>>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempt to close the object. Read more

impl<T> Debug for PollFd<T>
where T: Debug + AsFd,

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

Formats the value using the given formatter. Read more

impl<T> Deref for PollFd<T>
where T: AsFd,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<PollFd<T> as Deref>::Target

Dereferences the value.

impl<T> IntoInner for PollFd<T>
where T: AsFd,

type Inner = SharedFd<T>

The inner type.

fn into_inner(self) -> <PollFd<T> as IntoInner>::Inner

Get the inner buffer.

impl<S> IntoMaybeTlsStream<S> for PollFd<S>
where S: AsFd,

fn into_maybe_tls_stream(self) -> Result<MaybeTlsStream<PollFd<S>>, Error>

Convert this stream into a MaybeTlsStream.

impl<T> ToSharedFd<T> for PollFd<T>
where T: AsFd,

fn to_shared_fd(&self) -> SharedFd<T>

Return a cloned SharedFd.

Auto Trait Implementations§

impl<T> UnsafeUnpin for PollFd<T>
where PollFd<T>: UnsafeUnpin,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

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

Returns the borrowed file descriptor.

impl<R> AsyncReadExt for R
where R: AsyncRead + ?Sized,

fn chain<R>(self, next: R) -> Chain<Self, R>
where Self: Sized, R: AsyncRead,

Creates an adaptor which will chain this stream with another. Read more

fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> ⓘ
where Self: Unpin,

Tries to read some bytes directly into the given buf in asynchronous manner, returning a future type. Read more

fn read_vectored<'a>( &'a mut self, bufs: &'a mut [IoSliceMut<'a>], ) -> ReadVectored<'a, Self> ⓘ
where Self: Unpin,

Creates a future which will read from the AsyncRead into bufs using vectored IO operations. Read more

fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> ⓘ
where Self: Unpin,

Creates a future which will read exactly enough bytes to fill buf, returning an error if end of file (EOF) is hit sooner. Read more

fn read_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self> ⓘ
where Self: Unpin,

Creates a future which will read all the bytes from this AsyncRead. Read more

fn read_to_string<'a>( &'a mut self, buf: &'a mut String, ) -> ReadToString<'a, Self> ⓘ
where Self: Unpin,

Creates a future which will read all the bytes from this AsyncRead. Read more

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)
where Self: Sized + AsyncWrite,

Helper method for splitting this read/write object into two halves. Read more

fn take(self, limit: u64) -> Take<Self>
where Self: Sized,

Creates an AsyncRead adapter which will read at most limit bytes from the underlying reader. Read more

impl<W> AsyncWriteExt for W
where W: AsyncWrite + ?Sized,

fn flush(&mut self) -> Flush<'_, Self> ⓘ
where Self: Unpin,

Creates a future which will entirely flush this AsyncWrite. Read more

fn close(&mut self) -> Close<'_, Self> ⓘ
where Self: Unpin,

Creates a future which will entirely close this AsyncWrite.

fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self> ⓘ
where Self: Unpin,

Creates a future which will write bytes from buf into the object. Read more

fn write_vectored<'a>( &'a mut self, bufs: &'a [IoSlice<'a>], ) -> WriteVectored<'a, Self> ⓘ
where Self: Unpin,

Creates a future which will write bytes from bufs into the object using vectored IO operations. Read more

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self> ⓘ
where Self: Unpin,

Write data into this object. Read more

fn into_sink<Item>(self) -> IntoSink<Self, Item>
where Item: AsRef<[u8]>, Self: Sized,

Available on crate feature sink only.

Allow using an [AsyncWrite] as a Sink<Item: AsRef<[u8]>>. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<C, T> CoordTranslate for T
where C: CoordTranslate, T: Deref<Target = C>,

type From = <C as CoordTranslate>::From

Specifies the object to be translated from

fn translate(&self, from: &<T as CoordTranslate>::From) -> (i32, i32)

Translate the guest coordinate to the guest coordinate

fn depth(&self, _from: &Self::From) -> i32

Get the Z-value of current coordinate

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<S> IsTty for S
where S: AsRawFd,

fn is_tty(&self) -> bool

Returns true when an instance is a terminal teletype, otherwise false.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more