Noratrieb/stuff
1
0
Fork 0
mirror of https://github.com/Noratrieb/stuff.git synced 2026-01-14 16:35:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
nora 2022-10-16 15:43:21 +02:00 • committed by GitHub
parent cd7d924318
commit 94fcab3625
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -22,9 +22,8 @@ the user, allowing the user to do their bit stuffing only on integers (pointer a
choice of `Backend` (defaults to `usize`, `u64` and `u128` are also possible). It can store a choice of `Backend` (defaults to `usize`, `u64` and `u128` are also possible). It can store a
pointer or some `other` data. pointer or some `other` data.
You can choose any arbitrary bitstuffing depending on the `StuffingStrategy`, an unsafe trait that governs You can choose any arbitrary bitstuffing depending on the `StuffingStrategy`, a trait that governs
how the `other` data (or the pointer itself) will be packed into the backend. While this trait is still unsafe, how the `other` data (or the pointer itself) will be packed into the backend.
it's a lot safer than doing everything by hand.
# Example: NaN-Boxing # Example: NaN-Boxing
Pointers are hidden in the NaN values of floats. NaN boxing often involves also hiding booleans Pointers are hidden in the NaN values of floats. NaN boxing often involves also hiding booleans
@ -90,4 +89,4 @@ drop(unsafe { Box::from_raw(ptr.ptr().unwrap()) });
# MSRV-Policy # MSRV-Policy
`stuff`s current MSRV is `1.34.2`. This version *can* get increased in a non-breaking change, but such changes `stuff`s current MSRV is `1.34.2`. This version *can* get increased in a non-breaking change, but such changes
are avoided unless necessary. Features requiring a newer Rust version might get gated behind optional features in the futurey. are avoided unless necessary. Features requiring a newer Rust version might get gated behind optional features in the future.