commit	da443767149f341bd29667510367b5fc414ab4dd	[log] [tgz]
author	Android Build Coastguard Worker <android-build-coastguard-worker@google.com>	Tue Aug 31 03:05:24 2021 +0000
committer	Android Build Coastguard Worker <android-build-coastguard-worker@google.com>	Tue Aug 31 03:05:24 2021 +0000
tree	a7327c00c4ad66828baae503e55beb060509c093
parent	a4e107363fc88d53d5635a8321aa490f2fc23341 [diff]
parent	20ae0fe717f91d93d9599b3f24da233c18f4fc34 [diff]

tree: a7327c00c4ad66828baae503e55beb060509c093

README.md

rusticata-macros

Rusticata-macros

Helper macros for the rusticata project.

This crate contains some additions to nom.

For example, the error_if! macro allows to test a condition and return an error from the parser if the condition fails:

use rusticata_macros::error_if;
let r : IResult<&[u8],()> = do_parse!(
    s,
    l: be_u8 >>
    error_if!(l < 4, ErrorKind::Verify) >>
    data: take!(l - 4) >>
    (())
    );

See the documentation for more details and examples.

Nom versions

Different versions of this crate are available, depending on nom version.

rusticata-macros 0.3.x depends on nom 6
rusticata-macros 0.2.x depends on nom 5

Documentation

Crate is documented, do running cargo doc will crate the offline documentation.

Reference documentation can be found here

Changes

3.0.1

Add be_var_u64 and le_var_u64

3.0.0

Upgrade to nom 6

2.1.0

Add common trait Serialize for structures serialization

2.0.4

Add function version of most combinators

2.0.3

Add macros q (quote) and align32

2.0.2

Add upgrade_error and upgrade_error_to

2.0.1

Add macro custom_check
Add macro flat_take

2.0.0

Upgrade to nom 5
Debug types: use newtypes

1.1.0

Add macro newtype_enum

1.0.0

Upgrade to nom 4.0
- Warning: this is a breaking change!
Mark parse_uint24 as deprecated

License

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

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.