bbtree 0.1.2

Blessed B-tree.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

//! bbtree: the blessed B-tree.

#![no_std]
#![deny(unsafe_op_in_unsafe_fn)]
#![deny(clippy::undocumented_unsafe_blocks)]

extern crate alloc;

#[cfg(test)]
extern crate std;

mod allocator;
mod inline_key;
mod map;
mod proof;
#[cfg_attr(
    not(test),
    expect(dead_code, reason = "the tree's tests use the rest of its API")
)]
mod tree;
pub mod unsync;

pub use allocator::{AllocError, Allocator, Global};
pub use inline_key::{Auto, InlineKey, InlineKeyStrategy, InlineWidth, InlineWord, WithInlineKey};
pub use map::BBTreeMap;

/// Read-only views of a map's nodes, from [`unsync::BBTreeMap::inspect`], as the map
/// stores them: for the visualizer (`vis/`), behind the `inspect` feature,
/// which promises no stability.
#[cfg(feature = "inspect")]
pub mod inspect {
    pub use crate::tree::inspect::{
        BatchPoll, BatchTrace, LaneFetch, NodeId, NodeView, PageMap, SlotArray, SlotContents,
        TraceOutcome, TraceStep, TreeView,
    };
}

/// [`BBTreeMap`], an ordered map that threads share, and the types that go
/// with it.
pub mod bbtree_map {
    pub use crate::map::{BBTreeMap, IntoIter, IterMut, RangeCloned};
}