rtb-assets 0.5.2

Rust Tool Base — embedded-asset + overlay filesystem abstraction.
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

//! Typed errors for the asset subsystem.

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

/// Failures surfaced by asset access.
#[derive(Debug, Error, Diagnostic)]
#[non_exhaustive]
pub enum AssetError {
    /// No registered layer had the requested path.
    #[error("asset not found: {0}")]
    #[diagnostic(code(rtb::assets::not_found))]
    NotFound(String),

    /// The requested path exists but its bytes are not valid UTF-8
    /// (used by `open_text`).
    #[error("asset `{path}` is not valid UTF-8")]
    #[diagnostic(code(rtb::assets::not_utf8))]
    NotUtf8 {
        /// The offending path.
        path: String,
    },

    /// A structured-format parse failed (YAML/JSON/…).
    #[error("failed to parse asset `{path}` as {format}: {message}")]
    #[diagnostic(code(rtb::assets::parse), help("verify the file is well-formed {format}"))]
    Parse {
        /// The offending path.
        path: String,
        /// The expected format (`"YAML"`, `"JSON"`, …).
        format: &'static str,
        /// The underlying parser's message.
        message: String,
    },
}