Crate bonsaidb_local
source · [−]Expand description
BonsaiDb’s offline database implementation.
This crate exposes BonsaiDb’s local database implementation. The
Storage
type provides its most common functionality by
implementing the StorageConnection
.
Minimum Supported Rust Version (MSRV)
While this project is alpha, we are actively adopting the current version of
Rust. The current minimum version is 1.58
, and we plan on updating the MSRV to
implement namespaced
Features as soon as the
feature is released.
Feature Flags
By default, the full
feature is enabled. These features are prefixed by
local-
when being enabled from the omnibus bonsaidb
crate.
full
: Enables all the flags belowasync
: Enables async-compatible typescli
: Enables theclap
structures for embedding database management commands into your own command-line interface.encryption
: Enables at-rest encryption.instrument
: Enables instrumenting withtracing
.multiuser
: Enables multi-user support.password-hashing
: Enables the ability to use password authentication using Argon2.
Re-exports
pub use argon2;
pub use bonsaidb_core as core;
Modules
Command-line interface helpers.
Configuration options.
Encryption and secret management.
Structs
A database stored in BonsaiDb. This type blocks the current thread when
used. See AsyncDatabase
for this type’s async counterpart.
A file-based, multi-database, multi-user database engine. This type blocks
the current thread when used. See AsyncStorage
for
this type’s async counterpart.
A subscriber for PubSub
messages.
Enums
Errors that can occur from interacting with storage.
Traits
A location to store and restore a database from.
Operations that can be performed on both Database
and
AsyncDatabase
.
Functionality that is available on both Storage
and
AsyncStorage
.