sceptre 0.2.0

Rust reimplementation of EasyOCR (CRAFT detection + gen2 CRNN recognition) over ONNX.
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

//! Error types for sceptre.
//!
//! Philosophy (mirrors the xberg convention):
//!
//! - System errors ([`OcrError::Io`]) bubble up unchanged via `#[from]`.
//! - Application errors are structured variants carrying a `message` plus an
//!   optional `#[source]` so the underlying error chain is preserved.
//!
//! The library uses `thiserror`; the CLI uses `anyhow` on top of it.

use thiserror::Error;

/// Standard result type for all fallible operations in sceptre.
pub type Result<T> = std::result::Result<T, OcrError>;

/// The single error type for all sceptre operations.
#[derive(Debug, Error)]
pub enum OcrError {
    /// A file-system or I/O operation failed. Always bubbles up unchanged.
    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    /// Loading, resolving, downloading, or verifying a model failed.
    #[error("Model error: {message}")]
    Model {
        /// Human-readable description of the model failure.
        message: String,
        /// Underlying error, if any.
        #[source]
        source: Option<Box<dyn std::error::Error + Send + Sync>>,
    },

    /// An inference backend returned an error or unusable output.
    #[error("Inference error: {message}")]
    Inference {
        /// Human-readable description of the inference failure.
        message: String,
        /// Underlying error from the backend, if any.
        #[source]
        source: Option<Box<dyn std::error::Error + Send + Sync>>,
    },

    /// Image decoding or manipulation failed.
    #[error("Image error: {message}")]
    Image {
        /// Human-readable description of the image failure.
        message: String,
        /// Underlying error from the image library, if any.
        #[source]
        source: Option<Box<dyn std::error::Error + Send + Sync>>,
    },

    /// Invalid configuration or input parameters were supplied.
    #[error("Config error: {message}")]
    Config {
        /// Human-readable description of the configuration failure.
        message: String,
        /// Underlying error, if any.
        #[source]
        source: Option<Box<dyn std::error::Error + Send + Sync>>,
    },

    /// A catch-all for uncommon errors that do not fit another variant.
    #[error("{0}")]
    Other(String),
}

impl OcrError {
    /// Create a [`OcrError::Model`] error without a source.
    pub fn model(message: impl Into<String>) -> Self {
        Self::Model {
            message: message.into(),
            source: None,
        }
    }

    /// Create an [`OcrError::Inference`] error without a source.
    pub fn inference(message: impl Into<String>) -> Self {
        Self::Inference {
            message: message.into(),
            source: None,
        }
    }

    /// Create an [`OcrError::Image`] error without a source.
    pub fn image(message: impl Into<String>) -> Self {
        Self::Image {
            message: message.into(),
            source: None,
        }
    }

    /// Create an [`OcrError::Config`] error without a source.
    pub fn config(message: impl Into<String>) -> Self {
        Self::Config {
            message: message.into(),
            source: None,
        }
    }
}