# tokio::io::sink - Rust
API documentation for the Rust `sink` fn in crate `tokio`.
Keywords: rust, rustlang, rust-lang, sink

# Function tokio::io::sink [−] [src]

    pub fn sink() -> Sink

Creates an instance of an async writer which will successfully consume all data.

All calls to `poll_write` on the returned instance will return `Poll::Ready(Ok(buf.len()))` and the contents of the buffer will not be inspected.

This is an asynchronous version of `std::io::sink`.

# Examples

    use tokio::io::{self, AsyncWriteExt};

    #[tokio::main]
    async fn main() -> io::Result<()> {
        let buffer = vec![1, 2, 3, 5, 8];
        let num_bytes = io::sink().write(&buffer).await?;
        assert_eq!(num_bytes, 5);
        Ok(())
    }