rkv 0.20.0

A simple, humane, typed key-value storage solution
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

// Copyright 2018-2019 Mozilla
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use
// this file except in compliance with the License. You may obtain a copy of the
// License at http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software distributed
// under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
// CONDITIONS OF ANY KIND, either express or implied. See the License for the
// specific language governing permissions and limitations under the License.

use std::{fmt, io, path::PathBuf};

use bincode::Error as BincodeError;

use crate::{backend::traits::BackendError, error::StoreError};

#[derive(Debug)]
pub enum ErrorImpl {
    KeyValuePairNotFound,
    EnvPoisonError,
    DbsFull,
    DbsIllegalOpen,
    DbNotFoundError,
    DbIsForeignError,
    UnsuitableEnvironmentPath(PathBuf),
    IoError(io::Error),
    BincodeError(BincodeError),
}

impl BackendError for ErrorImpl {}

impl fmt::Display for ErrorImpl {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        match self {
            ErrorImpl::KeyValuePairNotFound => write!(fmt, "KeyValuePairNotFound (safe mode)"),
            ErrorImpl::EnvPoisonError => write!(fmt, "EnvPoisonError (safe mode)"),
            ErrorImpl::DbsFull => write!(fmt, "DbsFull (safe mode)"),
            ErrorImpl::DbsIllegalOpen => write!(fmt, "DbIllegalOpen (safe mode)"),
            ErrorImpl::DbNotFoundError => write!(fmt, "DbNotFoundError (safe mode)"),
            ErrorImpl::DbIsForeignError => write!(fmt, "DbIsForeignError (safe mode)"),
            ErrorImpl::UnsuitableEnvironmentPath(_) => {
                write!(fmt, "UnsuitableEnvironmentPath (safe mode)")
            }
            ErrorImpl::IoError(e) => e.fmt(fmt),
            ErrorImpl::BincodeError(e) => e.fmt(fmt),
        }
    }
}

impl Into<StoreError> for ErrorImpl {
    fn into(self) -> StoreError {
        // The `StoreError::KeyValuePairBadSize` error is unused, because this
        // backend supports keys and values of arbitrary sizes.
        // The `StoreError::MapFull` and `StoreError::ReadersFull` are
        // unimplemented yet, but they should be in the future.
        match self {
            ErrorImpl::KeyValuePairNotFound => StoreError::KeyValuePairNotFound,
            ErrorImpl::BincodeError(_) => StoreError::FileInvalid,
            ErrorImpl::DbsFull => StoreError::DbsFull,
            ErrorImpl::UnsuitableEnvironmentPath(path) => {
                StoreError::UnsuitableEnvironmentPath(path)
            }
            ErrorImpl::IoError(error) => StoreError::IoError(error),
            _ => StoreError::SafeModeError(self),
        }
    }
}

impl From<io::Error> for ErrorImpl {
    fn from(e: io::Error) -> ErrorImpl {
        ErrorImpl::IoError(e)
    }
}

impl From<BincodeError> for ErrorImpl {
    fn from(e: BincodeError) -> ErrorImpl {
        ErrorImpl::BincodeError(e)
    }
}