Lines
27.03 %
Functions
20.55 %
Branches
100 %
use std::convert::Infallible;
use std::fmt::Display;
use std::str::Utf8Error;
use std::string::FromUtf8Error;
use std::sync::Arc;
use bonsaidb_core::permissions::PermissionDenied;
use bonsaidb_core::pubsub::{Disconnected, TryReceiveError};
use bonsaidb_core::schema::{view, InsertError, InvalidNameError};
use bonsaidb_core::AnyError;
use nebari::AbortError;
use crate::database::compat::UnknownVersion;
/// Errors that can occur from interacting with storage.
#[derive(thiserror::Error, Debug)]
pub enum Error {
/// An error occurred interacting with the storage layer, `nebari`.
#[error("error from storage: {0}")]
Nebari(#[from] nebari::Error),
/// An error occurred serializing the contents of a `Document` or results of a `View`.
#[error("error while serializing: {0}")]
Serialization(#[from] pot::Error),
/// An internal error occurred while waiting for or sending a message.
#[error("error while communicating internally")]
InternalCommunication,
/// A transaction was too large to execute.
#[error("transaction is too large")]
TransactionTooLarge,
/// An error occurred while executing a view
#[error("error from view: {0}")]
View(#[from] view::Error),
/// An error occurred in the secrets storage layer.
#[error("a vault error occurred: {0}")]
#[cfg(feature = "encryption")]
Vault(#[from] crate::vault::Error),
/// An error occurred decompressing a stored value.
#[cfg(feature = "compression")]
Compression(#[from] lz4_flex::block::DecompressError),
/// A collection requested to be encrypted, but encryption is disabled.
#[error("encryption is disabled, but a collection is requesting encryption")]
#[cfg(not(feature = "encryption"))]
EncryptionDisabled,
/// An core error occurred.
#[error("a core error occurred: {0}")]
Core(#[from] bonsaidb_core::Error),
/// A tokio task failed to execute.
#[cfg(feature = "async")]
#[error("a concurrency error ocurred: {0}")]
TaskJoin(#[from] tokio::task::JoinError),
/// An io error occurred.
#[error("an IO error occurred: {0}")]
Io(#[from] std::io::Error),
/// An error occurred from a job and couldn't be unwrapped due to clones.
#[error("an error from a job occurred: {0}")]
Job(Arc<Error>),
/// An error occurred from backing up or restoring.
#[error("a backup error: {0}")]
Backup(Box<dyn AnyError>),
/// An error occurred with a password hash.
#[cfg(all(feature = "password-hashing", feature = "cli"))]
#[error("error reading password: {0}")]
CommandLinePassword(#[from] crate::cli::ReadPasswordError),
}
impl Error {
pub(crate) fn other(origin: impl Display, error: impl Display) -> Self {
Self::Core(bonsaidb_core::Error::other(origin, error))
impl<T> From<InsertError<T>> for Error {
fn from(err: InsertError<T>) -> Self {
Self::Core(err.error)
impl From<flume::RecvError> for Error {
fn from(_: flume::RecvError) -> Self {
Self::InternalCommunication
impl From<TryReceiveError> for Error {
fn from(_: TryReceiveError) -> Self {
impl From<Disconnected> for Error {
fn from(_: Disconnected) -> Self {
impl From<bincode::Error> for Error {
fn from(err: bincode::Error) -> Self {
Self::other("bincode", err)
impl<T> From<UnknownVersion<T>> for Error {
fn from(err: UnknownVersion<T>) -> Self {
Self::other("unknown versiion", err)
#[cfg(feature = "password-hashing")]
impl From<argon2::Error> for Error {
fn from(err: argon2::Error) -> Self {
Self::other("argon2", err)
impl From<argon2::password_hash::Error> for Error {
fn from(err: argon2::password_hash::Error) -> Self {
impl From<tokio::sync::oneshot::error::RecvError> for Error {
fn from(_: tokio::sync::oneshot::error::RecvError) -> Self {
impl From<tokio::sync::oneshot::error::TryRecvError> for Error {
fn from(_: tokio::sync::oneshot::error::TryRecvError) -> Self {
impl From<Error> for bonsaidb_core::Error {
fn from(err: Error) -> Self {
match err {
Error::View(view::Error::Core(core)) | Error::Core(core) => core,
other => Self::other("bonsaidb-local", other),
impl From<Arc<Error>> for Error {
fn from(err: Arc<Error>) -> Self {
match Arc::try_unwrap(err) {
Ok(err) => err,
Err(still_wrapped) => Error::Job(still_wrapped),
impl From<FromUtf8Error> for Error {
fn from(err: FromUtf8Error) -> Self {
Self::Core(bonsaidb_core::Error::InvalidUnicode(err.to_string()))
impl From<Utf8Error> for Error {
fn from(err: Utf8Error) -> Self {
impl From<InvalidNameError> for Error {
fn from(err: InvalidNameError) -> Self {
Self::Core(bonsaidb_core::Error::from(err))
impl From<AbortError<Infallible>> for Error {
fn from(err: AbortError<Infallible>) -> Self {
AbortError::Nebari(error) => Self::Nebari(error),
AbortError::Other(_) => unreachable!(),
impl From<AbortError<Error>> for Error {
fn from(err: AbortError<Error>) -> Self {
AbortError::Other(error) => error,
impl From<PermissionDenied> for Error {
fn from(err: PermissionDenied) -> Self {
#[test]
fn test_converting_error() {
use serde::ser::Error as _;
let err: bonsaidb_core::Error = Error::Serialization(pot::Error::custom("mymessage")).into();
bonsaidb_core::Error::Other { error, .. } => {
assert!(error.contains("mymessage"));
_ => unreachable!(),