File: ptr.md

package info (click to toggle)
rust-coreutils 0.7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 505,620 kB
  • sloc: ansic: 103,594; asm: 28,570; sh: 8,910; python: 5,581; makefile: 472; cpp: 97; javascript: 72
file content (22 lines) | stat: -rw-r--r-- 832 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# 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.

[`BitPtr`]: self::BitPtr
[`BitRef`]: self::BitRef
[`core::ptr`]: core::ptr