logloom 1.0.0

Parse, validate, and export changelogs with a CLI and Rust library
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

use std::fmt;

/// Classification of a parsing failure, independent of its human-readable text.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum ErrorKind {
    /// No non-whitespace content was supplied.
    EmptyInput,
    /// No release heading recognized by the selected format was found.
    NoReleases,
    /// A release heading could not be interpreted without guessing.
    MalformedHeading,
    /// The document uses an unsupported structural arrangement.
    UnsupportedStructure,
    /// The input exceeds a documented size or nesting limit.
    ResourceLimit,
    /// A structured input (for example JSON or a Debian record) is malformed.
    MalformedInput,
}

/// A structured parsing failure with an optional one-based source line.
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct ParseError {
    /// Machine-readable error classification.
    pub kind: ErrorKind,
    /// One-based source line, when the failure has a specific location.
    pub line: Option<usize>,
    /// Actionable description of the failure.
    pub message: String,
}

impl ParseError {
    /// Construct a typed failure with an optional one-based input line.
    #[must_use]
    pub fn new(kind: ErrorKind, line: Option<usize>, message: impl Into<String>) -> Self {
        Self {
            kind,
            line,
            message: message.into(),
        }
    }
}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if let Some(line) = self.line {
            write!(f, "line {line}: ")?;
        }
        f.write_str(&self.message)
    }
}

impl std::error::Error for ParseError {}