ctrl-z

A composable reader to treat 0x1A as an end-of-file marker.

Historically, 0x1A (commonly referred to as CTRL-Z, ^Z, or a "substitute character") was used in old systems to explicitly mark the end of a file. While modern systems no longer require this practice, some legacy files still contain this byte to mark the end of a file. This library provides a reader to treat 0x1A as the end of a file, rather than reading it as a regular byte.

Usage

This library provides a reader in the form of a struct named ReadToCtrlZ. As is common practice, this reader is composable with other types implementing the Read or BufRead traits. The reader checks the returned bytes for the presence of the EOF marker 0x1A and stops reading when it is encountered.

Example

For example, the reader defined below only reads until the 0x1A byte, at which point it stops reading.

use ctrl_z::ReadToCtrlZ;

let mut reader = ReadToCtrlZ::new(b"foo\x1abar".as_slice());
let mut output = String::new();

// Reading omits the final `0x1A` byte.
assert!(reader.read_to_string(&mut output).is_ok());
assert_eq!(output, "foo");

Minimum Supported Rust Version

This crate is guaranteed to compile on stable rustc 1.0.0 and up.

License

This project is licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution