panimg-core 0.3.0

Core library for panimg image processing
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

use serde::Serialize;
use std::path::PathBuf;

/// Exit codes for structured error reporting.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(into = "u8")]
pub enum ExitCode {
    Success = 0,
    General = 1,
    InputFile = 2,
    OutputIssue = 3,
    Unsupported = 4,
    BadArgs = 5,
}

impl From<ExitCode> for u8 {
    fn from(code: ExitCode) -> u8 {
        code as u8
    }
}

/// Structured error type for panimg.
#[derive(Debug, thiserror::Error, Serialize)]
#[serde(tag = "error", rename_all = "snake_case")]
pub enum PanimgError {
    #[error("file not found: {path}")]
    FileNotFound { path: PathBuf, suggestion: String },

    #[error("permission denied: {path}")]
    PermissionDenied { path: PathBuf, suggestion: String },

    #[error("unsupported format: {format}")]
    UnsupportedFormat { format: String, suggestion: String },

    #[error("unknown format for: {path}")]
    UnknownFormat { path: PathBuf, suggestion: String },

    #[error("decode error: {message}")]
    DecodeError {
        message: String,
        #[serde(skip_serializing_if = "Option::is_none")]
        path: Option<PathBuf>,
        suggestion: String,
    },

    #[error("encode error: {message}")]
    EncodeError {
        message: String,
        #[serde(skip_serializing_if = "Option::is_none")]
        path: Option<PathBuf>,
        suggestion: String,
    },

    #[error("output already exists: {path}")]
    OutputExists { path: PathBuf, suggestion: String },

    #[error("invalid argument: {message}")]
    InvalidArgument { message: String, suggestion: String },

    #[error("resize error: {message}")]
    ResizeError { message: String, suggestion: String },

    #[error("io error: {message}")]
    IoError {
        message: String,
        #[serde(skip_serializing_if = "Option::is_none")]
        path: Option<PathBuf>,
        suggestion: String,
    },
}

impl PanimgError {
    pub fn exit_code(&self) -> ExitCode {
        match self {
            Self::FileNotFound { .. } | Self::PermissionDenied { .. } => ExitCode::InputFile,
            Self::OutputExists { .. } => ExitCode::OutputIssue,
            Self::UnsupportedFormat { .. } | Self::UnknownFormat { .. } => ExitCode::Unsupported,
            Self::InvalidArgument { .. } => ExitCode::BadArgs,
            Self::DecodeError { .. } => ExitCode::InputFile,
            Self::EncodeError { .. } | Self::IoError { .. } => ExitCode::OutputIssue,
            Self::ResizeError { .. } => ExitCode::General,
        }
    }

    pub fn suggestion(&self) -> &str {
        match self {
            Self::FileNotFound { suggestion, .. }
            | Self::PermissionDenied { suggestion, .. }
            | Self::UnsupportedFormat { suggestion, .. }
            | Self::UnknownFormat { suggestion, .. }
            | Self::DecodeError { suggestion, .. }
            | Self::EncodeError { suggestion, .. }
            | Self::OutputExists { suggestion, .. }
            | Self::InvalidArgument { suggestion, .. }
            | Self::ResizeError { suggestion, .. }
            | Self::IoError { suggestion, .. } => suggestion,
        }
    }
}

pub type Result<T> = std::result::Result<T, PanimgError>;