Splittable

compio::io::util

Trait Splittable 

pub trait Splittable {
    type ReadHalf;
    type WriteHalf;

    // Required method
    fn split(self) -> (Self::ReadHalf, Self::WriteHalf);
}
Available on crate feature io only.
Expand description

A trait for types that can be split into separate read and write halves.

This trait enables an I/O type to be divided into two separate components: one for reading and one for writing. This is particularly useful in async contexts where you might want to perform concurrent read and write operations from different tasks.

§Implementor

  • Any (R, W) tuple implements this trait.
  • TcpStream, UnixStream and references to them in compio::net implement this trait without any lock thanks to the underlying sockets’ duplex nature.
  • File and named pipes in compio::fs implement this trait with ReadHalf and WriteHalf being the file itself since it’s reference-counted under the hood.
  • For other type to be compatible with this trait, it must be wrapped with Split, which wrap the type in a unsynced or synced lock depends on whether sync feature is turned on.

Required Associated Types§

type ReadHalf

The type of the read half, which normally implements AsyncRead or AsyncReadAt.

type WriteHalf

The type of the write half, which normally implements AsyncWrite or AsyncWriteAt.

Required Methods§

fn split(self) -> (Self::ReadHalf, Self::WriteHalf)

Consumes self and returns a tuple containing separate read and write halves.

The returned halves can be used independently to perform read and write operations respectively, potentially from different tasks concurrently.

Implementations on Foreign Types§

§

impl<R, W> Splittable for (R, W)

§

type ReadHalf = R

§

type WriteHalf = W

§

fn split( self, ) -> (<(R, W) as Splittable>::ReadHalf, <(R, W) as Splittable>::WriteHalf)

Implementors§