dpcs 0.2.0

Reference implementation of the Data Pipeline Contract Standard (DPCS)
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

//! Error types for parsing and I/O failures.

use std::path::PathBuf;

/// Convenient result alias for fallible DPCS operations.
pub type Result<T> = std::result::Result<T, Error>;

/// Errors that prevent construction of a Canonical Object Model.
///
/// Validation findings are reported through [`crate::ValidationReport`], not
/// this type. `Error` is reserved for parse and I/O failures.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// Failed to read a file from disk.
    #[error("failed to read `{path}`: {source}")]
    Io {
        /// Path that could not be read.
        path: PathBuf,
        /// Underlying I/O error.
        source: std::io::Error,
    },

    /// YAML document could not be parsed into the Canonical Object Model.
    #[error("YAML parse error: {0}")]
    Yaml(#[from] serde_yaml::Error),

    /// JSON document could not be parsed into the Canonical Object Model.
    #[error("JSON parse error: {0}")]
    Json(#[from] serde_json::Error),

    /// Document path uses an unsupported extension.
    #[error("unsupported document format for `{path}` (expected .yaml, .yml, or .json)")]
    UnsupportedFormat {
        /// Path with an unsupported extension.
        path: PathBuf,
    },

    /// Failed to serialize diagnostics or CLI output.
    #[error("{0}")]
    Serialization(String),
}