rsearch-storage 0.2.0

Object storage backends for rSearch: local filesystem, S3/MinIO, and node-replicated
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

use thiserror::Error;

/// Errors returned by the object storage backends.
#[derive(Debug, Error)]
pub enum StorageError {
    /// The requested object key does not exist.
    #[error("object not found: {0}")]
    NotFound(String),

    /// Key rejected before any I/O (traversal, absolute path, or
    /// otherwise malformed).
    #[error("invalid object key: {0}")]
    InvalidKey(String),

    /// Filesystem or network I/O failed while operating on a key.
    #[error("io error on {key}: {source}")]
    Io {
        /// Object key the operation was acting on.
        key: String,
        /// Underlying I/O error.
        #[source]
        source: std::io::Error,
    },

    /// Backend-specific failure (S3 API error, peer refusal, quorum
    /// shortfall, misconfiguration).
    #[error("backend error on {key}: {message}")]
    Backend {
        /// Object key the operation was acting on (may be empty for
        /// configuration errors).
        key: String,
        /// Backend-provided failure description.
        message: String,
    },
}

/// Convenience alias for results carrying [`StorageError`].
pub type StorageResult<T> = Result<T, StorageError>;