adrs-core 0.7.5

Core library for managing Architecture Decision Records
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

//! Error types for adrs-core.

use std::path::PathBuf;

/// Result type alias using the library's error type.
pub type Result<T> = std::result::Result<T, Error>;

/// Errors that can occur when working with ADRs.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// The ADR directory was not found.
    #[error("ADR directory not found. Run 'adrs init' to create one.")]
    AdrDirNotFound,

    /// The ADR directory already exists.
    #[error("ADR directory already exists: {0}")]
    AdrDirExists(PathBuf),

    /// An ADR was not found.
    #[error("ADR not found: {0}")]
    AdrNotFound(String),

    /// Multiple ADRs matched a query.
    #[error("Multiple ADRs match '{query}': {matches:?}")]
    AmbiguousAdr {
        /// The query string that matched more than one ADR.
        query: String,
        /// Human-readable identifiers of the ADRs that matched.
        matches: Vec<String>,
    },

    /// Invalid ADR number.
    #[error("Invalid ADR number: {0}")]
    InvalidNumber(String),

    /// Invalid ADR format (parsing failed).
    #[error("Invalid ADR format in {path}: {reason}")]
    InvalidFormat {
        /// Path to the ADR file that failed to parse.
        path: PathBuf,
        /// Why parsing failed.
        reason: String,
    },

    /// Missing required field in ADR.
    #[error("Missing required field '{field}' in {path}")]
    MissingField {
        /// Path to the ADR file missing the field.
        path: PathBuf,
        /// Name of the required field that was missing.
        field: String,
    },

    /// Invalid status value.
    #[error("Invalid status: {0}")]
    InvalidStatus(String),

    /// Invalid link format.
    #[error("Invalid link format: {0}")]
    InvalidLink(String),

    /// Template not found.
    #[error("Template not found: {0}")]
    TemplateNotFound(String),

    /// Template rendering error.
    #[error("Template error: {0}")]
    TemplateError(String),

    /// Configuration error.
    #[error("Configuration error: {0}")]
    ConfigError(String),

    /// I/O error.
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),

    /// YAML parsing error.
    #[error("YAML error: {0}")]
    Yaml(#[from] serde_yaml_neo::Error),

    /// TOML parsing error.
    #[error("TOML error: {0}")]
    Toml(#[from] toml::de::Error),
}