Module io

I/O functionality.

Extends: std::{io}

---

Derived work

This module includes derived work from the no_std_io crate (a fork of the core2 crate), including the following modifications:

• removed memchr dependency.
• prefix items with Io and io_.
• replace not very sound implementations using Initializer with safer ones.
• add safe and unsafe internal implementations of previously only unsafe ones.
• replaced extensive documentation copied from std by links to original docs.
• remove impls and conversions of recreated types for the replaced std types.

Structs

• IoBufReader
  ?std Adds buffering to any reader.
• IoBufWriter
  ?std Wraps a writer and buffers its output.
• IoBytes
  ?std An iterator over u8 values of a reader.
• IoChain
  ?std Adapter to chain together two readers.
• IoCursor
  ?std Wraps an in-memory buffer and provides it with a IoSeek implementation.
• IoError
  🚩+ ?std Error type for I/O operations of IoRead, IoWrite, IoSeek, and associated traits.
• IoLineWriter
  ?std Like BufWriter, but flushing whenever a newline (0x0a, ' ') is detected.
• IoLinesstd
  std An iterator over the lines of an instance of IoBufRead.
• IoSinkstd
  std A writer which will move data into the void.
• IoSlicestd
  std A buffer type used with IoWrite::write_vectored.
• IoSliceMutstd
  std A buffer type used with IoRead::read_vectored.
• IoSplitstd
  std An iterator over the contents of an instance of BufRead split on a particular byte.
• IoTake
  ?std Reader adapter which limits the bytes read from an underlying reader.

Enums

• IoErrorKind
  🚩+ ?std A list specifying general categories of I/O error.

Traits

• IoBufRead
  ?std A type of Reader which has an internal buffer.
• IoRead
  ?std Allows for reading bytes from a source.
• IoSeek
  ?std Provides a cursor which can be moved within a stream of bytes.
• IoWrite
  ?std A trait for objects which are byte-oriented sinks.

Functions

• io_copy
  ?std Copies the entire contents of a reader into a writer.
• io_emptystd
  std Creates a value that is always at EOF for reads, and ignores all data written.
• io_read_to_stringstd
  std Read all bytes from a reader into a new String
• io_repeatstd
  std Creates an instance of a reader that infinitely repeats one byte.
• io_sinkstd
  std Creates an instance of a writer which will successfully consume all data.
• io_stderrstd
  std Constructs a new handle to the standard error of the current process.
• io_stdinstd
  std Constructs a new handle to the standard input of the current process.
• io_stdoutstd
  std Constructs a new handle to the standard output of the current process.

Type Aliases

• IoResult
  ⚖️ ?std A specialized Result type for I/O operations.