This crate is still very much a work in progress.
A macro for compiling Kaitai Struct into Rust.
Given the following file basic_be.ksy
:
meta:
id: basic
endian: be
seq:
- id: header
type: u2
- id: body
type: s8
- id: tail
type: u4
The rust code to read a basic_be
buffer would look something like this:
#[kaitai_source("../tests/formats/basic_be.ksy")]
struct BasicBigEndian;
fn main() -> Result<()> {
let file = BasicBigEndian::from_file("tests/files/example.basic")?;
println!("header: {}", file.header);
println!("body: {}", file.body);
println!("tail: {}", file.tail);
}
The filepath provided to kaitai_source
is taken relative to the current file, similarly to how
modules are found. However, the filepath provided to from_file
is taken relative to the root
of the project, like std::fs::File::open
.
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
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.