credent_fs_model 0.2.0

Reads / Writes credentials from / to disk.
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use std::{
    fmt::{self, Display},
    path::PathBuf,
};

use credent_model::Profiles;

/// Errors when reading the user credentials file.
#[derive(Debug)]
pub enum Error {
    /// Unable to determine user configuration directory.
    UserConfigDirNotFound,
    /// Failed to create the parent directory of the credentials file.
    CredentialsParentDirFailedToCreate {
        /// Path to the user credentials file.
        parent_path: PathBuf,
        /// The underlying IO error.
        io_error: std::io::Error,
    },
    /// User credentials file does not exist.
    CredentialsFileNonExistent {
        /// Path to the user credentials file.
        credentials_path: PathBuf,
    },
    /// User credentials file is a directory.
    CredentialsFileIsDir {
        /// Path to the user credentials file.
        credentials_path: PathBuf,
    },
    /// Failed to read from the user credentials file.
    CredentialsFileFailedToRead {
        /// Path to the user credentials file.
        credentials_path: PathBuf,
        /// The underlying IO error.
        io_error: std::io::Error,
    },
    /// Failed to write to the user credentials file.
    CredentialsFileFailedToWrite {
        /// Path to the user credentials file.
        credentials_path: PathBuf,
        /// The underlying IO error.
        io_error: std::io::Error,
    },
    /// Failed to deserialize user credentials file contents.
    CredentialsFileFailedToDeserialize {
        /// Path to the user credentials file.
        credentials_path: PathBuf,
        /// The underlying TOML error.
        toml_de_error: toml::de::Error,
    },
    /// Failed to serialize user credentials.
    CredentialsFileFailedToSerialize {
        /// Profiles which failed to be serialized.
        profiles: Profiles,
        /// The underlying TOML error.
        toml_ser_error: toml::ser::Error,
    },
}

impl Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::UserConfigDirNotFound => {
                write!(f, "Unable to determine user configuration directory.")
            }
            Self::CredentialsParentDirFailedToCreate {
                parent_path,
                io_error,
            } => write!(
                f,
                "Failed to create credentials file parent directory.\n\
                Path: `{}`\n\
                Error: `{}`",
                parent_path.display(),
                io_error
            ),
            Self::CredentialsFileNonExistent { credentials_path } => write!(
                f,
                "User credentials does not exist or cannot be accessed. Path: `{}`",
                credentials_path.display()
            ),
            Self::CredentialsFileIsDir { credentials_path } => write!(
                f,
                "User credentials file should be a file, but it is a directory. Path: `{}`",
                credentials_path.display()
            ),
            Self::CredentialsFileFailedToRead {
                credentials_path,
                io_error,
            } => write!(
                f,
                "User credentials file failed to be read.\n\
                Path: `{}`\n\
                Error: `{}`",
                credentials_path.display(),
                io_error
            ),
            Self::CredentialsFileFailedToWrite {
                credentials_path,
                io_error,
            } => write!(
                f,
                "User credentials file failed to be read.\n\
                Path: `{}`\n\
                Error: `{}`",
                credentials_path.display(),
                io_error
            ),
            Self::CredentialsFileFailedToDeserialize {
                credentials_path,
                toml_de_error,
            } => write!(
                f,
                "User credentials file failed to be deserialized.\n\
                Path: `{}`\n\
                Error: `{}`",
                credentials_path.display(),
                toml_de_error
            ),
            Self::CredentialsFileFailedToSerialize {
                profiles,
                toml_ser_error,
            } => write!(
                f,
                "User credentials failed to be serialized.\n\
                Profiles: `{:?}`\n\
                Error: `{}`",
                profiles, toml_ser_error
            ),
        }
    }
}

impl std::error::Error for Error {}