Module vmap::io

Read/Write types for buffering.

Both the Ring and InfiniteRing are fixed size anonymous allocations utilizing circular address mappinng. The circular mapping ensures that the entire readable or writable slice may always be addressed as a single, contiguous allocation. However, these two types differ in one key way: the Ring may only written to as readable space is consumed, whereas the InfiniteRing is always writable and will overwrite unconsumed space as needed.

Structs

• BufReader
  The BufReader adds buffering to any reader using a specialized buffer.
• BufWriter
  The BufWriter adds buffering to any writer using a specialized buffer.
• InfiniteRing
  Fixed-size lossy read/write buffer with sequential address mapping.
• IntoInnerError
  An error returned by BufWriter::into_inner which combines an error that happened while writing out the buffer, and the buffered writer object which may be used to recover from the condition.
• Ring
  Fixed-size reliable read/write buffer with sequential address mapping.
• WriterPanicked
  Error returned for the buffered data from BufWriter::into_parts when the underlying writer has previously panicked. The contents of the buffer may be partially written.

Traits

• SeqRead
  Common input trait for all buffers.
• SeqWrite
  Common output trait for all buffers.