soar-package 0.3.1

Package format handling for soar package manager
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

//! Error types for the package crate.

use miette::Diagnostic;
use thiserror::Error;

/// Errors that can occur during package operations.
#[derive(Error, Diagnostic, Debug)]
pub enum PackageError {
    #[error("Error while {action}: {source}")]
    #[diagnostic(code(soar_package::io))]
    IoError {
        action: String,
        source: std::io::Error,
    },

    #[error("Failed to read magic bytes")]
    #[diagnostic(code(soar_package::magic_bytes))]
    MagicBytesError,

    #[error("Failed to seek in file")]
    #[diagnostic(code(soar_package::seek))]
    SeekError,

    #[error(transparent)]
    #[diagnostic(code(soar_package::image))]
    ImageError(#[from] image::ImageError),

    #[error(transparent)]
    #[diagnostic(code(soar_package::appimage))]
    AppImageError(#[from] squishy::error::SquishyError),

    #[error("Configuration error: {0}")]
    #[diagnostic(code(soar_package::config))]
    ConfigError(String),

    #[error("{0}")]
    #[diagnostic(code(soar_package::custom))]
    Custom(String),
}

/// A specialized Result type for package operations.
pub type Result<T> = std::result::Result<T, PackageError>;

/// Extension trait for adding context to I/O errors.
pub trait ErrorContext<T> {
    /// Adds context to an error, describing what action was being performed.
    fn with_context<C>(self, context: C) -> Result<T>
    where
        C: FnOnce() -> String;
}

impl<T> ErrorContext<T> for std::io::Result<T> {
    fn with_context<C>(self, context: C) -> Result<T>
    where
        C: FnOnce() -> String,
    {
        self.map_err(|err| {
            PackageError::IoError {
                action: context(),
                source: err,
            }
        })
    }
}

impl From<soar_config::error::ConfigError> for PackageError {
    fn from(err: soar_config::error::ConfigError) -> Self {
        PackageError::ConfigError(err.to_string())
    }
}

impl From<soar_utils::error::FileSystemError> for PackageError {
    fn from(err: soar_utils::error::FileSystemError) -> Self {
        PackageError::Custom(err.to_string())
    }
}