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

remove confusing enum from readme

Browse source
This commit is contained in:
nora 2022-04-04 20:39:58 +02:00
parent c9dac90529
commit ce214f98bf
2 changed files with 4 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -13,13 +13,8 @@ This crate consists of three parts:
* The trait `Backend`
`StuffedPtr` is the main type of this crate. You it's a type whose size depends on the
choice of `Backend` (defaults to `usize`, `u64` and `u128` are also possible). It can store a
pointer or some extra data, so you can imagine it being
```rust
enum StuffedPtr<T, E> {
Ptr(*mut T),
Extra(E),
}
```
pointer or some extra data.
except that the extra data is bitstuffed into the pointer. You can chose any arbitrary bitstuffing
depending on the `StuffingStrategy`, an unsafe trait that governs how the extra data
(or the pointer itself) will be packed into the backend.