derive-io 0.2.0

derive macros for std::io::{Read,Write} and tokio's AsyncRead/AsyncWrite
Documentation

derive-io

A Rust crate that provides derive macros for implementing AsyncRead and AsyncWrite traits on structs and enums.

Features

  • Derive AsyncRead and AsyncWrite traits for structs and enums
  • Support for both named and tuple structs
  • Support for enums with multiple variants
  • Support for split read/write streams
  • Support for generic types
  • Individual methods can be overridden with custom implementations

Tokio

use tokio::net::*;
use derive_io::{AsyncRead, AsyncWrite};

#[derive(AsyncRead, AsyncWrite)]
pub enum TokioStreams {
    Tcp(#[read] #[write] TcpStream),
    #[cfg(unix)]
    Unix(#[read] #[write] UnixStream),
    Split{ 
        #[read] read: tokio::net::tcp::OwnedReadHalf, 
        #[write] write: tokio::net::tcp::OwnedWriteHalf,
    },
}

Generic types are supported. The generated implementations will automatically add a where clause to the impl block for each stream type.

use derive_io::{AsyncRead, AsyncWrite};

#[derive(AsyncRead, AsyncWrite)]
pub struct Generic<S> { // where S: AsyncRead + AsyncWrite
    #[read]
    #[write]
    stream: S,
}

Override one method in the write implementation:

use derive_io::{AsyncRead, AsyncWrite};

#[derive(AsyncRead, AsyncWrite)]
pub struct Override {
    #[read]
    #[write(poll_write=override_poll_write)]
    stream: tokio::net::TcpStream,
}

pub fn override_poll_write(
    stm: std::pin::Pin<&mut tokio::net::TcpStream>,
    cx: &mut std::task::Context<'_>,
    buf: &[u8],
) -> std::task::Poll<std::io::Result<usize>> {
    todo!()
}