Struct futures_test::sink::InterleavePending

pub struct InterleavePending<T> { /* private fields */ }

Wrapper that interleaves Poll::Pending in calls to poll.

See the interleave_pending methods on:

• FutureTestExt
• StreamTestExt
• SinkTestExt
• AsyncReadTestExt
• AsyncWriteTestExt

Implementations

impl<T> InterleavePending<T>

pub fn get_ref(&self) -> &T

Acquires a reference to the underlying I/O object that this adaptor is wrapping.

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

Acquires a mutable reference to the underlying I/O object that this adaptor is wrapping.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>

Acquires a pinned mutable reference to the underlying I/O object that this adaptor is wrapping.

pub fn into_inner(self) -> T

Consumes this adaptor returning the underlying I/O object.

Trait Implementations

impl<R: AsyncBufRead> AsyncBufRead for InterleavePending<R>

fn poll_fill_buf(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<&[u8]>>

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amount: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<R: AsyncRead> AsyncRead for InterleavePending<R>

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

Attempt to read from the AsyncRead into buf.

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

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

impl<S: AsyncSeek> AsyncSeek for InterleavePending<S>

fn poll_seek(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    pos: SeekFrom
) -> Poll<Result<u64>>

Attempt to seek to an offset, in bytes, in a stream.

impl<W: AsyncWrite> AsyncWrite for InterleavePending<W>

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

Attempt to write bytes from buf into the object.

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

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

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

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

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

impl<T: Debug> Debug for InterleavePending<T>

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

Formats the value using the given formatter.

impl<Fut: FusedFuture> FusedFuture for InterleavePending<Fut>

fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

impl<St: FusedStream> FusedStream for InterleavePending<St>

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<Fut: Future> Future for InterleavePending<Fut>

type Output = Fut::Output

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<Si: Sink<Item>, Item> Sink<Item> for InterleavePending<Si>

type Error = Si::Error

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

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

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<St: Stream> Stream for InterleavePending<St>

type Item = St::Item

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin, T> Unpin for InterleavePending<T> where
    __InterleavePending<'pin, T>: Unpin,