Module a10::io

Type definitions for I/O functionality.

The main types of this module are the Buf and BufMut traits, which define the requirements on buffers using the I/O system calls on an file descriptor (AsyncFd). Additionally the BufSlice and BufMutSlice traits existing to define the behaviour of buffers in vectored I/O.

A specialised read buffer pool implementation exists in ReadBufPool, which is a buffer pool managed by the kernel when making read(2)-like system calls.

Finally we have the stdin, stdout and stderr functions to create AsyncFds for standard in, out and error respectively.

Structs

• Close
  Future behind AsyncFd::close.
• Read
  Future behind AsyncFd::read.
• ReadBuf
  Buffer reference from a ReadBufPool.
• ReadBufPool
  A read buffer pool.
• ReadN
  Future behind AsyncFd::read_n.
• ReadNVectored
  Future behind AsyncFd::read_n_vectored.
• ReadVectored
  Future behind AsyncFd::read_vectored.
• Splice
  Future behind AsyncFd::splice_to.
• Stderr
  An AsyncFd for stderr.
• Stdin
  An AsyncFd for stdin.
• Stdout
  An AsyncFd for stdout.
• Write
  Future behind AsyncFd::write.
• WriteAll
  Future behind AsyncFd::write_all.
• WriteAllVectored
  Future behind AsyncFd::write_all_vectored.
• WriteVectored
  Future behind AsyncFd::write_vectored.

Traits

• Buf
  Trait that defines the behaviour of buffers used in writing, which requires read only access.
• BufMut
  Trait that defines the behaviour of buffers used in reading, which requires mutable access.
• BufMutSlice
  Trait that defines the behaviour of buffers used in reading using vectored I/O, which requires mutable access.
• BufSlice
  Trait that defines the behaviour of buffers used in writing using vectored I/O, which requires read only access.

Functions

• stderr
  Create a new Stderr.
• stdin
  Create a new Stdin.
• stdout
  Create a new Stdout.