Crate sakurai 

███████╗ █████╗ ██╗  ██╗██╗   ██╗██████╗  █████╗ ██╗
██╔════╝██╔══██╗██║ ██╔╝██║   ██║██╔══██╗██╔══██╗██║
███████╗███████║█████╔╝ ██║   ██║██████╔╝███████║██║
╚════██║██╔══██║██╔═██╗ ██║   ██║██╔══██╗██╔══██║██║
███████║██║  ██║██║  ██╗╚██████╔╝██║  ██║██║  ██║██║
╚══════╝╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝

Usage

Add to Cargo.toml:

[dependencies]
sakurai = "0.1.1"

Testing

Run the test suite:

cargo test

Run UB checks:

cargo +nightly miri test

Safety & Disclaimers

Sakurai uses a fair bit of unsafe code internally, but the outward APIs are safe Rust.

While this crate is well tested, it’s not recommended for production currently as some APIs are unstable (notably BTree). Use at your own risk.

███████╗ █████╗ ██╗ ██╗██╗ ██╗██████╗ █████╗ ██╗ ██╔════╝██╔══██╗██║ ██╔╝██║ ██║██╔══██╗██╔══██╗██║ ███████╗███████║█████╔╝ ██║ ██║██████╔╝███████║██║ ╚════██║██╔══██║██╔═██╗ ██║ ██║██╔══██╗██╔══██║██║ ███████║██║ ██║██║ ██╗╚██████╔╝██║ ██║██║ ██║██║ ╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═╝╚═╝

=====================================================

Re-exports

pub use btree::BTree;

pub use fixedvec::FixedVec;

pub use hashmap::HashMap;

pub use pivot::Pivot;

pub use pivot::PivotBuffer;

pub use queue::Queue;

pub use ring::RingBuffer;

pub use stack::Stack;

Modules

btree

fixedvec

hashmap

pivot

queue

ring

stack

Macros

fixedvec

Mirror of the vec! macro, for creating a FixedVec with initial values.

hashmap

Create a HashMap with initial values.

likely

unlikely