diff --git a/README.md b/README.md index c84f861..fe91269 100644 --- a/README.md +++ b/README.md @@ -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 { - 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. diff --git a/src/lib.rs b/src/lib.rs index 77d3396..88e620f 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -12,13 +12,8 @@ //! //! [`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 { -//! 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.