xvc-storage 0.7.0

Xvc remote and local storage management
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

//! Error messages for xvc-storage
use log::{debug, error, info, trace, warn};

use std::fmt::Debug;
use std::io;
use thiserror::Error as ThisError;

use crate::StorageIdentifier;

/// Error messages for xvc-storage
#[derive(ThisError, Debug)]
#[allow(missing_docs)]
pub enum Error {
    #[error("Sorry. {0} is not implemented yet")]
    Todo(&'static str),

    #[error("General Xvc Remote Error: {source}")]
    AnyhowError {
        #[from]
        source: anyhow::Error,
    },

    #[error("Xvc ECS Error: {source}")]
    EcsError {
        #[from]
        source: xvc_core::XvcEcsError,
    },

    #[error("Xvc Core Error: {source}")]
    CoreError {
        #[from]
        source: xvc_core::error::Error,
    },

    #[error("Xvc Config Error: {source}")]
    ConfigError {
        #[from]
        source: xvc_core::XvcConfigError,
    },

    #[error("Walker Error: {source}")]
    WalkerError {
        #[from]
        source: xvc_core::XvcWalkerError,
    },
    #[error("I/O Error: {source}")]
    IoError {
        #[from]
        source: io::Error,
    },
    #[error("Crossbeam Send Error for Type: {t:?} {cause:?}")]
    CrossbeamSendError { t: String, cause: String },

    #[error("Uuid Error: {source:?}")]
    UuidError {
        #[from]
        source: uuid::Error,
    },

    #[error("No Guid found for Xvc Repository")]
    NoRepositoryGuidFound,

    #[error("Cannot find storage with identifier: {identifier}")]
    CannotFindStorageWithIdentifier { identifier: StorageIdentifier },

    #[error("Cannot remove storage with identifier: {identifier}")]
    CannotRemoveStorageWithIdentifier { identifier: StorageIdentifier },

    #[error("Process Exec Error: {source}")]
    ProcessExecError {
        #[from]
        source: subprocess::PopenError,
    },

    #[error("Process Error.\nSTDOUT:\n{stdout}\nSTDERR:\n{stderr}")]
    ProcessError { stdout: String, stderr: String },

    #[error("Cannot Find Executable: {source}")]
    WhichError {
        #[from]
        source: which::Error,
    },

    #[error("Cloud credentials for storage '{storage_name}' not found. Please set ONE of the following pairs of environment variables: {var_pairs:?}")]
    CloudCredentialsNotFound {
        storage_name: String,
        var_pairs: Vec<(String, String)>,
    },

    #[cfg(any(feature = "s3", feature = "minio"))]
    #[error("Cloud Credentials Error: {source}")]
    CloudCredentialsError {
        #[from]
        source: s3::creds::error::CredentialsError,
    },
    #[cfg(any(feature = "s3", feature = "minio"))]
    #[error("S3 Error: {source}")]
    S3Error {
        #[from]
        source: s3::error::S3Error,
    },

    #[error("Environment Variable Error: {source}")]
    VarError {
        #[from]
        source: std::env::VarError,
    },

    #[error("This storage type does not support file sharing with signed URLs")]
    StorageDoesNotSupportSignedUrls,
}

impl<T> From<crossbeam_channel::SendError<T>> for Error
where
    T: Debug,
{
    fn from(e: crossbeam_channel::SendError<T>) -> Self {
        Error::CrossbeamSendError {
            t: format!("{:#?}", e.0),
            cause: e.to_string(),
        }
    }
}

impl Error {
    /// Write error message to stderr using [log::debug] and return the error
    pub fn debug(self) -> Self {
        debug!("{}", self);
        self
    }
    /// Write error message to stderr using [log::trace] and return the error
    pub fn trace(self) -> Self {
        trace!("{}", self);
        self
    }

    /// Write error message to stderr using [log::warn] and return the error
    pub fn warn(self) -> Self {
        warn!("{}", self);
        self
    }
    /// Write error message to stderr using [log::error] and return the error
    pub fn error(self) -> Self {
        error!("{}", self);
        self
    }
    /// Write error message to stderr using [log::info] and return the error
    pub fn info(self) -> Self {
        info!("{}", self);
        self
    }
    /// Write error message to stderr using [panic!] and quit.
    pub fn panic(self) -> Self {
        panic!("{}", self);
    }
}

/// Result type for xvc-storage crate
pub type Result<T> = std::result::Result<T, Error>;