Struct streamcatcher::future::Compat

pub struct Compat<T> { /* fields omitted */ }

Compatibility adapter for futures and I/O types.

Implementations

impl<T> Compat<T>

pub fn new(t: T) -> Compat<T>

Applies the compatibility adapter to a future or an I/O type.

Examples

Apply it to a future:

use async_compat::Compat;
use std::time::Duration;

futures::executor::block_on(Compat::new(async {
    // We can use tokio's timers because we're inside tokio context.
    tokio::time::sleep(Duration::from_secs(1)).await;
}));

Apply it to an I/O type:

use async_compat::{Compat, CompatExt};
use futures::prelude::*;

futures::executor::block_on(Compat::new(async {
    // The `write_all` method comes from `futures::io::AsyncWriteExt`.
    Compat::new(tokio::io::stdout()).write_all(b"hello\n").await?;
    Ok(())
}))

pub fn get_ref(&self) -> &T

Gets a shared reference to the inner value.

Examples

use async_compat::Compat;
use tokio::net::UdpSocket;

futures::executor::block_on(Compat::new(async {
    let socket = Compat::new(UdpSocket::bind("127.0.0.1:0").await?);
    let addr = socket.get_ref().local_addr()?;
    Ok(())
}))

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

Gets a mutable reference to the inner value.

Examples

use async_compat::Compat;
use tokio::net::TcpListener;

futures::executor::block_on(Compat::new(async {
    let mut listener = Compat::new(TcpListener::bind("127.0.0.1:0").await?);
    let (stream, addr) = listener.get_mut().accept().await?;
    let stream = Compat::new(stream);
    Ok(())
}))

pub fn into_inner(self) -> T

Unwraps the compatibility adapter.

Examples

use async_compat::Compat;

let stdout = Compat::new(tokio::io::stdout());
let original = stdout.into_inner();

Trait Implementations

impl<T> AsyncBufRead for Compat<T> where
    T: AsyncBufRead, 

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

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

pub fn consume(self: Pin<&mut Compat<T>>, amt: 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<T> AsyncBufRead for Compat<T> where
    T: AsyncBufRead, 

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

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

pub fn consume(self: Pin<&mut Compat<T>>, amt: 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<T> AsyncRead for Compat<T> where
    T: AsyncRead, 

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

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, Error>>

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

impl<T> AsyncRead for Compat<T> where
    T: AsyncRead, 

pub fn poll_read(
    self: Pin<&mut Compat<T>>,
    cx: &mut Context<'_>,
    buf: &mut ReadBuf<'_>
) -> Poll<Result<(), Error>>

Attempts to read from the AsyncRead into buf.

impl<T> AsyncSeek for Compat<T> where
    T: AsyncSeek, 

pub fn start_seek(self: Pin<&mut Compat<T>>, pos: SeekFrom) -> Result<(), Error>

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

pub fn poll_complete(
    self: Pin<&mut Compat<T>>,
    cx: &mut Context<'_>
) -> Poll<Result<u64, Error>>

Waits for a seek operation to complete.

impl<T> AsyncSeek for Compat<T> where
    T: AsyncSeek, 

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

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

impl<T> AsyncWrite for Compat<T> where
    T: AsyncWrite, 

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

Attempt to write bytes from buf into the object.

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

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

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

Attempt to close the object.

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

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

impl<T> AsyncWrite for Compat<T> where
    T: AsyncWrite, 

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

Attempt to write bytes from buf into the object.

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

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

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

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<T> Future for Compat<T> where
    T: Future, 

type Output = <T as Future>::Output

The type of value produced on completion.

pub fn poll(
    self: Pin<&mut Compat<T>>,
    cx: &mut Context<'_>
) -> Poll<<Compat<T> as Future>::Output>

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

impl<'__pin, T> Unpin for Compat<T> where
    __Origin<'__pin, T>: Unpin,