Crate format_struct

A crate for quick and easy format structure definitions for use in binary file parsing.

Usage

This crate should be used by invoking the provided format_struct macro like this:

use format_struct::{format_struct, FromByteSlice};

// Here we define a small structure.
format_struct! {
    struct little Test {
        foo: u8,
        bar: u32,
        baz: [u8; 2],
    }
}

// This is the data we want to parse:
let data = &[
    0x42u8, // this goes into foo
    0x39, 0x05, 0x00, 0x00, // this goes into bar
    0xaa, 0x55, // this goes into baz
][..];

// This is completely zero-cost since the implementation is just a transmute.
let s = Test::from_byte_slice(data).unwrap();

// Each integer field access compiles to a single unaligned memory access instruction.
assert_eq!(s.foo, 0x42);
assert_eq!(s.bar.get(), 1337);
assert_eq!(&s.baz, &[0xaa, 0x55]);

Re-exports

• pub use endian::BigEndian;
• pub use endian::Endian;
• pub use endian::LittleEndian;

Modules

• endian
  Provides types and traits for representing endianness of an integer encoding.

Macros

• format_struct
  Defines a structure that can be transmuted from/into a byte slice for parsing/constructing binary formats in a zero-copy way.

Structs

• I16
  A type that wraps a byte array to be decoded into a i16.
• I32
  A type that wraps a byte array to be decoded into a i32.
• I64
  A type that wraps a byte array to be decoded into a i64.
• I128
  A type that wraps a byte array to be decoded into a i128.
• InvalidSizeError
  The error type returned when a slice provided to any of the FromByteSlice methods didn’t meet their size constraints.
• U16
  A type that wraps a byte array to be decoded into a u16.
• U32
  A type that wraps a byte array to be decoded into a u32.
• U64
  A type that wraps a byte array to be decoded into a u64.
• U128
  A type that wraps a byte array to be decoded into a u128.

Traits

• FromByteSlice
  An unsafe trait for types that byte slices may be transmuted into.