Module bitvec::ptr

source ·
Expand description

Raw Pointer Implementation

This provides bitvec-internal pointer types and a mirror of the core::ptr module.

It contains the following types:

  • BitPtr is a raw-pointer to exactly one bit.
  • BitRef is a proxy reference to exactly one bit.
  • BitSpan is the encoded form of the *BitSlice pointer and &BitSlice reference. It is not publicly exposed, but it serves as the foundation of bitvec’s ability to describe memory regions.

It also provides ports of the free functions available in core::ptr, as well as some utilities for bridging ordinary Rust pointers into bitvec.

You should generally not use the contents of this module; BitSlice provides more convenience and has stronger abilities to optimize performance.

Structs

  • Single-Bit Pointer
  • Bit-Pointer Range
  • Proxy Bit-Reference
  • A basic const marker.
  • The error produced when an address is insufficiently aligned to the width of its type.
  • A basic mut marker.

Enums

  • Errors produced by invalid bit-pointer components.
  • An error produced when creating BitSpan encoded references.

Traits

Functions