byte_reader
A minimal byte-by-byte reader for parsing input.
## Use case
Following situation:
> I want to read and parse some input, but it's **not so large-scale** parsing task, so I'd like to avoid adding a *heavyweight* crate like [nom](https://crates.io/crates/nom) or [nom8](https://crates.io/crates/nom8) to my `dependencies` ...
Of course, `byte_reader` supports *no std* environment.
```rust
use byte_reader::Reader;
fn main() {
// Get an input `&[u8]` from a File, standard input, or others
let sample_input = "Hello, byte_reader!".as_bytes();
// Create mutable `r` for the input
let mut r = Reader::new(sample_input);
// Use some simple operations
// to parse the input
r.consume("Hello").unwrap();
r.consume(",").unwrap();
r.skip_whitespace();
let name = r.read_while(|b| b != &b'!'); // b"byte_reader"
let name = String::from_utf8_lossy(name).to_string();
r.consume("!").unwrap();
println!("Greeted to `{name}`.");
}
```
## Operations
- `remaining`
- `read_while`, `read_until`
- `next`, `next_if`
- `peek`, `peek2`, `peek3`
- `advance_by`, `unwind_by`
- `consume`, `consume_oneof`
- `skip_while`, `skip_whitespace`
## Features
### `"location"`
Enable tracking reader's location, **line** and **column** (1-origin), in the input bytes.
### `"text"`
Some utility methods for text-parsing are availableļ¼
- `read_quoted_by`
- `read_uint`, `read_int`
- `read_camel`, `read_snake`, `read_kebab`
## License
`byte_reader` is licensed under the MIT License ([LICENSE](https://github.com/kana-rus/byte_reader/blob/main/LICENSE) or [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT)).
