composefs-storage 0.4.0

Read-only access to containers-storage (overlay driver)
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

//! Error types for the cstorage library.
//!
//! This module defines the error types used throughout the library. All operations
//! that can fail return a [`Result<T>`] which is an alias for `Result<T, StorageError>`.
//!
//! # Error Categories
//!
//! Errors are organized into several categories:
//!
//! - **Storage errors**: [`RootNotFound`], [`InvalidStorage`]
//! - **Entity errors**: [`LayerNotFound`], [`ImageNotFound`]
//! - **Link resolution**: [`LinkReadError`]
//! - **Tar-split processing**: [`TarSplitError`]
//! - **System errors**: [`Io`], [`JsonParse`]
//!
//! [`RootNotFound`]: StorageError::RootNotFound
//! [`InvalidStorage`]: StorageError::InvalidStorage
//! [`LayerNotFound`]: StorageError::LayerNotFound
//! [`ImageNotFound`]: StorageError::ImageNotFound
//! [`LinkReadError`]: StorageError::LinkReadError
//! [`TarSplitError`]: StorageError::TarSplitError
//! [`Io`]: StorageError::Io
//! [`JsonParse`]: StorageError::JsonParse

use std::path::PathBuf;

/// Result type alias for operations that may return a StorageError.
pub type Result<T> = std::result::Result<T, StorageError>;

/// Error types for storage operations.
#[derive(Debug, thiserror::Error)]
pub enum StorageError {
    /// Storage root directory was not found at the specified path.
    #[error("storage root not found at {0}")]
    RootNotFound(PathBuf),

    /// Storage validation failed with the provided reason.
    #[error("invalid storage: {0}")]
    InvalidStorage(String),

    /// The requested layer was not found.
    #[error("layer not found: {0}")]
    LayerNotFound(String),

    /// The requested image was not found.
    #[error("image not found: {0}")]
    ImageNotFound(String),

    /// Failed to read a link file.
    #[error("failed to read link file: {0}")]
    LinkReadError(String),

    /// Error related to tar-split processing.
    #[error("tar-split error: {0}")]
    TarSplitError(String),

    /// I/O error occurred during file operations.
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),

    /// JSON parsing error occurred.
    #[error("JSON parse error: {0}")]
    JsonParse(#[from] serde_json::Error),
}