signet-storage 0.10.0

Unified storage interface for Signet hot and cold storage
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

//! Storage configuration types and environment parsing.
//!
//! This module provides environment variable constants and error types
//! for storage configuration.
//!
//! # Environment Variables
//!
//! | Variable | Description | Required When |
//! |----------|-------------|---------------|
//! | `SIGNET_HOT_PATH` | Path to hot MDBX database | Always |
//! | `SIGNET_COLD_PATH` | Path to cold MDBX database | Cold backend is MDBX |
//! | `SIGNET_COLD_SQL_URL` | SQL connection string | Cold backend is SQL |
//!
//! Exactly one of `SIGNET_COLD_PATH` or `SIGNET_COLD_SQL_URL` must be set.

use signet_cold_mdbx::MdbxConnectorError;
use thiserror::Error;

#[cfg(any(feature = "postgres", feature = "sqlite"))]
use signet_cold_sql::SqlConnectorError;

/// Environment variable name for hot storage path.
pub const ENV_HOT_PATH: &str = "SIGNET_HOT_PATH";

/// Environment variable name for cold MDBX storage path.
pub const ENV_COLD_PATH: &str = "SIGNET_COLD_PATH";

/// Environment variable name for cold SQL connection URL.
pub const ENV_COLD_SQL_URL: &str = "SIGNET_COLD_SQL_URL";

/// Configuration errors.
#[derive(Debug, Error)]
pub enum ConfigError {
    /// Required environment variable is missing.
    #[error("missing environment variable: {0}")]
    MissingEnvVar(&'static str),

    /// Cold backend not specified.
    #[error("no cold backend specified: set either {ENV_COLD_PATH} or {ENV_COLD_SQL_URL}")]
    MissingColdBackend,

    /// Multiple cold backends specified.
    #[error("ambiguous cold backend: both {ENV_COLD_PATH} and {ENV_COLD_SQL_URL} are set")]
    AmbiguousColdBackend,

    /// Required feature not enabled.
    #[error("feature '{feature}' required for {env_var} but not enabled")]
    FeatureNotEnabled {
        /// The feature name that is required.
        feature: &'static str,
        /// The environment variable that requires the feature.
        env_var: &'static str,
    },

    /// MDBX connector error.
    #[error("MDBX connector error: {0}")]
    MdbxConnector(#[from] MdbxConnectorError),

    /// SQL connector error.
    #[cfg(any(feature = "postgres", feature = "sqlite"))]
    #[error("SQL connector error: {0}")]
    SqlConnector(#[from] SqlConnectorError),
}