Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wcampbell0x2a committed May 31, 2024
1 parent e1ba70d commit f23c70d
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,12 @@ environment, you will see logging messages as Deku does its deserialising.
- `DekuError` whenever possible will use a `'static str`, to make the errors compile away when following a
guide such as [min-sized-rust](/~https://github.com/johnthagen/min-sized-rust).
# Performance: Compile without `bitvec`
The feature `bits` enables the `bitvec` crate to use when reading and writing, which is enabled by default.
This however slows down the reading and writing process if your code doesn't use `bits` and the `bit_offset`
in `from_bytes`. While this option isn't fully tested, you can be sure to be creating the most performant
code possible for byte only reading by _not_ using this feature.
*/
#![warn(missing_docs)]
#![cfg_attr(not(feature = "std"), no_std)]
Expand Down

0 comments on commit f23c70d

Please sign in to comment.