Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilyvion/nombytes
nombytes is a library that provides a wrapper for the bytes::Bytes byte container for use with nom.
https://github.com/ilyvion/nombytes
Last synced: 8 days ago
JSON representation
nombytes is a library that provides a wrapper for the bytes::Bytes byte container for use with nom.
- Host: GitHub
- URL: https://github.com/ilyvion/nombytes
- Owner: ilyvion
- License: apache-2.0
- Created: 2022-07-23T20:13:26.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-08-01T10:38:35.000Z (over 2 years ago)
- Last Synced: 2024-12-23T08:35:58.678Z (16 days ago)
- Language: Rust
- Homepage:
- Size: 1.27 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# NomBytes
[](https://crates.io/crates/nombytes)
[](https://crates.io/crates/nombytes)
[](https://crates.io/crates/nombytes)
[](https://docs.rs/nombytes)
[](https://alexschrod.github.io/nombytes/)
[](https://github.com/alexschrod/nombytes/actions/workflows/CI.yml)
[](https://codecov.io/gh/alexschrod/nombytes)
[](https://www.codacy.com/gh/alexschrod/nombytes/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexschrod/nombytes&utm_campaign=Badge_Grade)
`nombytes` is a library that provides a wrapper for the `bytes::Bytes` byte
container for use with nom.
I originally made this so that I could have a function take a file name path
and return parsed values that still had references to the loaded file without
running into the lifetime issues associated with `&[u8]` and `&str` that
would prevent me from doing so. I decided to release it as a crate so that
others can make use of my efforts too.
This library has been tested to work with `bytes` down to v5.3.0 and `nom` down
to v6.0.0 and has been marked as such in its `Cargo.toml`.
## Usage
Put this in your `Cargo.toml`:
```toml
[dependencies]
nombytes = "0.1.1"
```
## Features
### `miette`
With the `miette` feature enabled, the `NomBytes` implements its
`SourceCode` trait so it can be used directly with `miette`'s
`#[source_code]` error attribute. This feature also enables the `std`
feature.
This library has been tested to work with `miette` down to v3.0.0 and
has been marked as such in its `Cargo.toml`.
### `serde`
Adds `serde::Serialize` and `serde::Deserialize` implementations to the types
in this library to allow for using them with `serde`.
### `std`
Enabled by default; allows creating `NomBytes` directly from `String`s
through a `From` impl. With this feature turned off, this crate
is `#![no_std]` compatible.
## Example
Borrowed from the `nom` crate, using `NomBytes` instead of `&str`. Had to be
modified slightly because `NomBytes` acts as `&[u8]` rather than as `&str`.
```rust
use nom::{
IResult,
bytes::complete::{tag, take_while_m_n},
combinator::map_res,
sequence::tuple};
use nombytes::NomBytes;
#[derive(Debug,PartialEq)]
pub struct Color {
pub red: u8,
pub green: u8,
pub blue: u8,
}
fn from_hex(input: NomBytes) -> Result {
u8::from_str_radix(input.to_str(), 16)
}
fn is_hex_digit(c: u8) -> bool {
(c as char).is_digit(16)
}
fn hex_primary(input: NomBytes) -> IResult {
map_res(
take_while_m_n(2, 2, is_hex_digit),
from_hex
)(input)
}
fn hex_color(input: NomBytes) -> IResult {
let (input, output) = tag("#")(input)?;
let (input, (red, green, blue)) = tuple((hex_primary, hex_primary, hex_primary))(input)?;
Ok((input, Color { red, green, blue }))
}
fn main() {
assert!(matches!(hex_color(NomBytes::from("#2F14DF")),
Ok((r, Color {
red: 47,
green: 20,
blue: 223,
})) if r.to_str() == ""));
}
```
## License
Licensed under either of
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license ([LICENSE-MIT](LICENSE-MIT) or )
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.