#deref #stable #trait #rc #box #unsafe #owning_ref #address #types

stable_deref_trait

An unsafe marker trait for types like Box and Rc that dereference to a stable address even when moved, and hence can be used with libraries such as owning_ref and rental.

3 stable releases

1.1.1 Aug 2, 2018
1.1.0 Jun 9, 2018
1.0.0 Mar 9, 2017

#2 in Memory management

Download history 12187/week @ 2018-05-10 15409/week @ 2018-05-17 14971/week @ 2018-05-24 15466/week @ 2018-05-31 16521/week @ 2018-06-07 17132/week @ 2018-06-14 17932/week @ 2018-06-21 18685/week @ 2018-06-28 18094/week @ 2018-07-05 18662/week @ 2018-07-12 20043/week @ 2018-07-19 18806/week @ 2018-07-26 20193/week @ 2018-08-02

74,697 downloads per month

This crate defines an unsafe marker trait, StableDeref, for container types which deref to a fixed address which is valid even when the containing type is moved. For example, Box, Vec, Rc, Arc and String implement this trait. Additionally, it defines CloneStableDeref for types like Rc where clones deref to the same address.

It is intended to be used by crates such as owning_ref and rental, as well as library authors who wish to make their code interoperable with such crates. For example, if you write a custom Vec type, you can implement StableDeref, and then users will be able to use your custom Vec type together with owning_ref and rental.

no_std support can be enabled by disabling default features (specifically "std"). In this case, the trait will not be implemented for the std types mentioned above, but you can still use it for your own types.

Enable the "alloc" feature (with default-features disabled) to have this trait be implemented for the above types from the built-in alloc crate, specifically

  • alloc::boxed::Box
  • alloc::vec::Vec
  • alloc::rc::Rc
  • alloc::arc::Arc
  • alloc::string::String

For example, this crate can be built with alloc support via the following command: cargo build --no-default-features --features alloc

Or added as a Cargo.toml dependency as follows:

[dependencies.stable_deref_trait]
version = "<version>"
default-features = false
features = [ "alloc" ]
MIT/Apache-2.0 license
  • No runtime deps

Reverse deps