encrypt_config 2.0.1

A Rust crate to manage, persist and encrypt your configurations.
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

//! The error types of `encrypt config`.

use snafu::Snafu;

/// The Error types of `encrypt config`, which is implemented by [`snafu`].
#[derive(Snafu, Debug)]
#[snafu(visibility(pub(crate)), context(suffix(false)))]
pub enum ConfigError {
    /// This error will be returned when the value cannot seriliazed or deserialized.
    #[snafu(
        display("Serde Error. Cannot seriliaze or deseriliaze."),
        context(false)
    )]
    SerdeError {
        /// The error returned by `serde_json`.
        source: serde_json::Error,
    },
    #[cfg(feature = "secret")]
    /// This error will be returned when the encrypter cannot be deserialized from keyring password. This may caused by the private key stored in keyring being incorrect, modified or recreated.
    #[snafu(display("Failed to deseriliaze encrypter from keyring."))]
    LoadEncrypterFailed,
    #[cfg(feature = "secret")]
    /// This error will be returned when the OS' secret manager cannot be accessed.
    #[snafu(
        display(
            "Keyring Error.\nThis error may caused by OS' secret manager, the rsa private key cannot be saved or read."
        ),
    )]
    KeyringError,
    /// This error will be returned when the encryption or decryption failed.
    #[snafu(
        display("Encryption Error. Cannot encrypt or decrypt.\nIf it's a decrypt error, maybe it's the private key stored in keyring being incorrect, modified or recreated."),
        context(false)
    )]
    #[cfg(feature = "secret")]
    EncryptionError {
        /// The error returned by `rsa`.
        source: rsa::Error,
    },
    /// This error will be returned when the config cannot be saved to or read from the file.
    #[snafu(display("IO error. Cannot operate the file."), context(false))]
    IoError {
        /// The error returned by `std::io`.
        source: std::io::Error,
    },
}

/// The Result type of `encrypt config`, which is implemented by [`snafu`].
pub type ConfigResult<T> = Result<T, ConfigError>;