How to install the pointdexter crate // Lib.rs

Adding `pointdexter` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add pointdexter

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

pointdexter = "1.0.0-rc1"

The pointdexter library will be automatically available globally.

Back to the crate overview.

Readme

Pointer Dexterity

In the Rust standard library, *const T and *mut T are wholly discrete and unrelated types, except that *mut T coerces into *const T via a compiler builtin. *mut T is notionally a subtype of *const T, but this relation is not expressed in the type system available to Rust user code.

This crate produces a unifying wrapper type over both pointers, called Pointer. It, like the raw pointer primitives in the standard library, is generic over the pointee T. Unlike the raw pointer primitives, it is also generic over a [P: Permission][Permission] token.

The Permission System

The Permission trait and its implementors, Shared and Unique, provide a library-level reification of the Stacked Borrows model being built inside the Rust compiler’s provenance system. You can see in the Stacked Borrows documentation that it has a similar permission system that describes Unique and two different kinds of Shared. Pointdexter views the SharedReadWrite and SharedReadOnly values not as discrete states, but as stateful lenses over an original provenance.

In particular, any Unique permission in Pointdexter can be degraded to an equivalent of the Stacked-Borrows SharedReadWrite by pushing it into a type stack, (Shared, Unique). Pointdexter implements the Permission trait on all (Shared, impl Permission) tuples, which allows client code to always be able to push and unwind sharing information and change the type of a Pointer, rather than add runtime state that causes ABI changes.

Usage

This crate is primarily useful for other library or intermediate code that needs to generalize over write permissions. Applications tend to not need to be general in the same way and may benefit less from it.

All pointers and references can be converted into their corresponding Pointer, Reference, or NonNullPointer using .into(), .try_into(), or ::new(). Once converted, all stable standard-library APIs continue to exist.

This library was extracted from bitvec, where it was first built to support the custom pointer type that powers it. That crate’s source code is likely the best (and also likely only) example of how Pointdexter is meant to be used as an implementation detail of other libraries.

Pointdexter is a long name. Its prelude aliases the crate to ptxr. If you feel very confident, you can alias it to ptr and completely shadow the core module.

use pointdexter::prelude::*;

let mut data = 5i32;

let cptr: ptxr::Pointer<i32, Shared> = (&data).into();
let mptr: ptxr::Pointer<i32, Unique> = (&mut data).into();

Rust Version Compatibility

This crate begins its Rust support at 1.85, and uses feature gates to add APIs for successive releases.

If you want to use this crate on earlier Rust versions, please file an issue and I will lower the floor accordingly.

Enable the feature rust_1xy, where xy is the minor version of Rust you use, to enable the pointer APIs that are stable in your compiler. Use rust_now if you track the stable release train. Features begin at rust_186, as Rust 1.85 is the baseline and is always available.

Note that rust_now is a default feature! If you are pinning a Rust rather than floating on the stable series, you must set

[dependencies.pointdexter]
default-features = false
features = ["rust_1xy"]

Adding pointdexter library as a dependency

Adding `pointdexter` library as a dependency