nom-derive is a custom derive attribute, to derive [nom] parsers automatically from the structure definition.
It is not meant to replace [nom], but to provide a quick and easy way to generate parsers for structures, especially for simple structures. This crate aims at simplifying common cases. In some cases, writing the parser manually will remain more efficient.
Nom
attribute. This is the main
documentation for this crate, with all possible options and many examples.Feedback welcome !
#[derive(Nom)]
This crate exposes a single custom-derive macro Nom
which
implements parse
for the struct it is applied to.
The goal of this project is that:
derive(Nom)
should be enough for you to derive [nom] parsers for simple
structures easily, without having to write it manuallynom-derive
adds declarative parsing to nom
. It also allows mixing with
procedural parsing easily, making writing parsers for byte-encoded formats
very easy.
For example:
```rust use nom_derive::Nom;
struct S { a: u32, b: u16, c: u16 } ```
This adds a static method parse
to S
, with the following signature:
rust,ignore
impl S {
pub fn parse(i: &[u8]) -> nom::IResult(&[u8], S);
}
To parse input, just call let res = S::parse(input);
.
For extensive documentation of all attributes and examples, see the Nom derive attribute documentation.
Many examples are provided, and more can be found in the project tests.
#[nom(DebugDerive)]
to the structure.
It will dump the generated parser to stderr
.#[nom(Debug)]
to the structure or
to fields. It wraps subparsers in dbg_dmp
and will print the field name and input to
stderr
if the parser fails.NomDeriveDebug
derive (replaced by DebugDerive
attribute)parse
method is now publicEnum
parser generator
NomDeriveDebug
attribute to display generated parser on stderr during buildCount
attributeLicensed under either of
at your option.
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.