10 releases (5 breaking)
0.7.0 | Jan 29, 2022 |
---|---|
0.6.1 | Aug 21, 2021 |
0.6.0 | Nov 17, 2019 |
0.5.1 | Nov 8, 2018 |
0.4.1 | Nov 26, 2016 |
#794 in Rust patterns
93 downloads per month
Used in gstuff
88KB
2K
SLoC
Assorted smart pointers for Rust.
Features:
Strong / Weak / Ref / RefMut
This is like Rc<RefCell<T>>
, but with slightly different trade-offs:
-
Configurable overhead (compared to a fixed 24 or 12 for
Rc<RefCell<T>>
) -
The default of 4 bytes overhead gives you max 1024 immutable references, 1024 strong references and 1024 weak references, but this can easily be tweaked with just a few lines of code.
-
Poisoning support - after a panic with an active mutable reference, trying to get mutable or immutable references will return an error. This can be reverted by calling unpoison().
There is also a thread-safe version which is something like an Arc<RwSpinlock<T>>
.
ARef
ARef takes over where OwningRef ends, by abstracting the owner even further.
This makes it possible to return, say, an ARef<str>
and have the caller drop the owner
when done looking at it, without having to bother about whether the owner is a String
, Rc<String>
, a
Ref<String>
, a simple &'static str
or something else.
It's also repr(C), so it can be transferred over an FFI boundary (if its target is repr(C), too).
RMBA
The RMBA wraps either a &T
, &mut T
, Box<T>
or Arc<T>
within the size of a single pointer.
It will panic if you try to store a struct that's not 32 bit aligned.
Bx, Bxm
These are just simple wrappers around Box
that lets you get rid of DerefMove.
This way you can return a Bx in your API and still be sure the inner struct does not move in memory. (This might be helpful if you're dealing with FFI or unsafe code.)
License
Apache 2.0 or MIT, at your preference.