fuel-core-database 0.44.0

The crates contains databases used by Fuel core protocol.
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

//! The crate `fuel-core-storage` contains storage types, primitives, tables used by `fuel-core`.
//! This crate doesn't contain the actual implementation of the storage. It works around the
//! `Database` and is used by services to provide a default implementation. Primitives
//! defined here are used by services but are flexible enough to customize the
//! logic when the `Database` is known.

#![deny(clippy::arithmetic_side_effects)]
#![deny(clippy::cast_possible_truncation)]
#![deny(missing_docs)]
#![deny(unused_crate_dependencies)]
#![deny(warnings)]
#![deny(unused_variables)]

use fuel_core_storage::{
    Error as StorageError,
    transactional::ReferenceBytesKey,
};
use fuel_core_types::services::executor::Error as ExecutorError;

/// The error occurred during work with any of databases.
#[derive(Debug, derive_more::Display, derive_more::From)]
#[non_exhaustive]
#[allow(missing_docs)]
pub enum Error {
    /// Error occurred during serialization or deserialization of the entity.
    #[display(fmt = "error performing serialization or deserialization")]
    Codec,
    /// The version of database or data is invalid (possibly not migrated).
    #[display(fmt = "Invalid database version, expected {expected:#x}, found {found:#x}")]
    InvalidDatabaseVersion {
        /// the current database version
        found: u32,
        /// the database version expected by this build of fuel-core
        expected: u32,
    },
    /// Multiple heights found in the commit to the database.
    #[display(fmt = "Multiple heights found in the commit {heights:?}")]
    MultipleHeightsInCommit {
        /// List of heights found in the commit.
        heights: Vec<u64>,
    },
    /// Failed to advance the height.
    #[display(fmt = "Failed to advance the height")]
    FailedToAdvanceHeight,
    /// The new and old heights are not linked.
    #[display(
        fmt = "New and old heights are not linked: prev_height: {prev_height:#x}, new_height: {new_height:#x}"
    )]
    HeightsAreNotLinked {
        /// The old height.
        prev_height: u64,
        /// The new height.
        new_height: u64,
    },
    /// The new height is not found, but the old height is set.
    #[display(
        fmt = "The new height is not found, but the old height is set: prev_height: {prev_height:#x}"
    )]
    NewHeightIsNotSet {
        /// The old height known by the database.
        prev_height: u64,
    },
    #[display(
        fmt = "The historical database doesn't have history for the requested height {requested_height:#x}"
    )]
    NoHistoryForRequestedHeight { requested_height: u64 },
    #[display(fmt = "Reached the end of the history")]
    ReachedEndOfHistory,

    #[cfg(feature = "backup")]
    #[display(fmt = "BackupEngine initialization error: {}", _0)]
    BackupEngineInitError(anyhow::Error),

    #[cfg(feature = "backup")]
    #[display(fmt = "Backup error: {}", _0)]
    BackupError(anyhow::Error),

    #[cfg(feature = "backup")]
    #[display(fmt = "Restore error: {}", _0)]
    RestoreError(anyhow::Error),

    #[display(fmt = "During committing of the changes found conflicting \
        modifications at column {column} for the key {key:?}")]
    ConflictingChanges { column: u32, key: ReferenceBytesKey },

    /// Not related to database error.
    #[from]
    Other(anyhow::Error),
}

#[cfg(feature = "test-helpers")]
impl PartialEq for Error {
    fn eq(&self, other: &Self) -> bool {
        self.to_string().eq(&other.to_string())
    }
}

impl From<Error> for anyhow::Error {
    fn from(error: Error) -> Self {
        anyhow::Error::msg(error)
    }
}

impl From<Error> for StorageError {
    fn from(e: Error) -> Self {
        StorageError::DatabaseError(Box::new(e))
    }
}

impl From<Error> for ExecutorError {
    fn from(e: Error) -> Self {
        ExecutorError::StorageError(format!("{}", StorageError::from(e)))
    }
}

#[cfg(test)]
fuel_core_trace::enable_tracing!();