simple_parse

crates.io mio Lines of Code

simple_parse is a declarative binary stream parser that aims to generate the most efficient parsing code possible for your custom types while remaining safe.

| Features | Description | |:----:|:----| | Fast| The generated parsing code is often faster than "idiomatic" C implementations| | No copy | Able to return references into byte slices | | Built-in endianness support | Annotating structs/fields with endian gives control over how numbers will be parsed | | Convert back to bytes | In addition to parsing arbitrary bytes, simple_parse also allows dumping structs back into binary form |

If simple_parse is unable to describe your complex/non-standard binary formats, take a look at deku.

Usage

Snippets taken from examples/struct.rs ```Rust use ::simple_parse::{SpRead, SpWrite};

[derive(SpRead, SpWrite)]

pub struct SomeStruct { pub some_field: u8, #[sp(endian="big")] pub items: Vec, }

// Emulate data coming from a socket let mut srvsock: &[u8] = &[ 1, // somefield 0,0,0,2, // items.len() 0xDE,0xAD,0xBE,0xEF, // items[0] 0xBA,0xDC,0x0F,0xFE // items[1] ];

// Parse incoming bytes into SomeStruct let mut mystruct = SomeStruct::fromreader(&mut srv_sock)?;

/// Modify the struct my_struct.items.push(0xFFFFFFFF);

/// Encode our struct back into bytes let mut clisock: Vec = Vec::new(); mystruct.towriter(&mut clisock)?; //dst_buf == [1, 0, 0, 0, 3, DE, AD, BE, EF, BA, DC, F, FE, FF, FF, FF, FF] ```

For complete examples see : examples

Project Goals

In vague order of priority, simple_parse aims to provide :

  1. Safety
  2. Performance
  3. Ease of use
  4. Adaptability

In other words, simple_parse will try to generate the most performant code while never compromising on safety.

Secondly, it also prioritize ease of use by providing default implementations that work well in most cases while also allowing some customisation to accomodate for binary formats we cannot control.

License

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.