async-dup

Crates.ioasync-dup
lib.rsasync-dup
version1.2.4
sourcesrc
created_at2020-05-31 13:45:02.559907
updated_at2023-12-02 19:03:18.767329
descriptionDuplicate an async I/O handle
homepagehttps://github.com/smol-rs/async-dup
repositoryhttps://github.com/smol-rs/async-dup
max_upload_size
id248167
size29,884
admins (github:smol-rs:admins)

documentation

https://docs.rs/async-dup

README

async-dup

Build License Cargo Documentation

Duplicate an async I/O handle.

This crate provides two tools, Arc and Mutex:

  • Arc implements AsyncRead, AsyncWrite, and AsyncSeek if a reference to the inner type does.
  • A reference to Mutex implements AsyncRead, AsyncWrite, and AsyncSeek if the inner type does.

Wrap an async I/O handle in Arc or Mutex to clone it or share among tasks.

Examples

Clone an async I/O handle:

use async_dup::Arc;
use futures::io;
use smol::Async;
use std::net::TcpStream;

// A client that echoes messages back to the server.
let stream = Async::<TcpStream>::connect("127.0.0.1:8000").await?;

// Create two handles to the stream.
let reader = Arc::new(stream);
let mut writer = reader.clone();

// Echo data received from the reader back into the writer.
io::copy(reader, &mut writer).await?;

Share an async I/O handle:

use async_dup::Mutex;
use futures::io;
use futures::prelude::*;

// Reads data from a stream and echoes it back.
async fn echo(stream: impl AsyncRead + AsyncWrite + Unpin) -> io::Result<u64> {
    let stream = Mutex::new(stream);
    io::copy(&stream, &mut &stream).await
}

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 38

cargo fmt