Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
smessmer committed Feb 10, 2024
1 parent cc5d52e commit 688180a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,9 @@ Anything that needs inplace zero-copy access to structured binary data.
- Convenient and simple macro DSL to define layouts.
- Define a fixed endianness in the layout, ensuring cross platform compatibility.
- Fully written in safe Rust, no [std::mem::transmute](https://doc.rust-lang.org/std/mem/fn.transmute.html) or similar shenanigans.
- Const generics make sure that all offset calculations happen at compile time and will not have a runtime overhead.
- Const generics ensure that all offset calculations happen at compile time.
This, together with inlining annotations, makes this library zero-overhead.
Using it is just as performant as writing manual slice accesses into your code.
- Comprehensive test coverage.

### Why not `#[repr(packed)]`?
Expand Down
4 changes: 3 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@
//! - Convenient and simple macro DSL to define layouts.
//! - Define a fixed endianness in the layout, ensuring cross platform compatibility.
//! - Fully written in safe Rust, no [std::mem::transmute](https://doc.rust-lang.org/std/mem/fn.transmute.html) or similar shenanigans.
//! - Const generics make sure that all offset calculations happen at compile time and will not have a runtime overhead.
//! - Const generics ensure that all offset calculations happen at compile time.
//! This, together with inlining annotations, makes this library zero-overhead.
//! Using it is just as performant as writing manual slice accesses into your code.
//! - Comprehensive test coverage.
//!
//! ## Why not `#[repr(packed)]`?
Expand Down

0 comments on commit 688180a

Please sign in to comment.