clankerdiff-core 0.1.1

Renderer-independent diff and code review domain model
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

//! Errors returned by the renderer-independent diff model.

/// Errors produced while constructing or decoding a repository-relative path.
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
pub enum RepoPathError {
    #[error("repository path is empty")]
    Empty,
    /// The path contained a NUL byte.
    #[error("repository path contains a NUL byte")]
    Nul,
    /// The path was absolute or contained a platform prefix.
    #[error("repository path must be relative")]
    Absolute,
    /// The path attempted to escape its repository root.
    #[error("repository path contains '.' or '..' component")]
    Traversal,
}

impl From<std::convert::Infallible> for RepoPathError {
    fn from(value: std::convert::Infallible) -> Self {
        match value {}
    }
}

#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
#[error("unknown diff scope `{0}`; expected unstaged, staged, or both")]
pub struct ParseDiffScopeError(pub String);

/// Errors shared by model and parser adapters.
#[derive(Debug, thiserror::Error)]
pub enum DiffError {
    /// A repository path could not be represented safely.
    #[error("unsupported path encoding: {0}")]
    UnsupportedPathEncoding(#[source] std::str::Utf8Error),
    /// A path failed the relative-path contract.
    #[error("invalid repository path: {0}")]
    InvalidPath(#[from] RepoPathError),
    /// A diff could not be parsed.
    #[error("failed to parse diff: {source}")]
    Parse {
        /// Structured parser error, including the failing input span.
        #[source]
        source: diffy::patch_set::PatchSetParseError,
    },
    /// An underlying UTF-8 conversion failed.
    #[error("invalid UTF-8: {0}")]
    Utf8(#[from] std::str::Utf8Error),
    /// A NUL-delimited porcelain record did not follow Git's v1 grammar.
    #[error("invalid git porcelain v1 record")]
    InvalidPorcelainEntry,
}

impl From<std::string::FromUtf8Error> for DiffError {
    fn from(error: std::string::FromUtf8Error) -> Self {
        Self::UnsupportedPathEncoding(error.utf8_error())
    }
}