xarf-rs 0.1.0

XARF v4 (eXtended Abuse Reporting Format) parser, validator, and generator with v3 compatibility
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
86
87
88

//! Error and result types for the XARF crate.

use thiserror::Error;

/// Top-level error type for the XARF crate. Returned by parsing, validation,
/// and v3-conversion entry points whose failure modes are fatal.
#[derive(Debug, Error)]
pub enum XarfError {
    /// The input was not syntactically valid JSON (or not a JSON object).
    #[error("invalid JSON: {0}")]
    InvalidJson(String),

    /// Schema-validation failure with a structured list of issues. Non-fatal
    /// failures (recoverable into a [`crate::ParseResult`]) are exposed as
    /// `errors` on the result; this variant only surfaces when no result can
    /// be produced.
    #[error("schema validation failed ({} error(s))", .0.len())]
    Validation(Vec<ValidationError>),

    /// A bundled schema failed to parse or compile. This should never happen
    /// for a published release of the crate; it indicates a programmer error.
    #[error("schema error: {0}")]
    Schema(String),

    /// A v3 report could not be converted to v4 (e.g. unknown `ReportType`,
    /// missing source identifier, malformed reporter email).
    #[error("v3 conversion failed: {0}")]
    V3Conversion(String),

    /// Evidence payload encoding/decoding or size-limit failure.
    #[error("evidence error: {0}")]
    Evidence(String),
}

/// A single structured validation issue.
///
/// `field` is a JSON-path-style descriptor of the offending location (empty
/// string for whole-document failures). `message` is a human-readable
/// description.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ValidationError {
    pub field: String,
    pub message: String,
}

impl ValidationError {
    pub fn new(field: impl Into<String>, message: impl Into<String>) -> Self {
        Self {
            field: field.into(),
            message: message.into(),
        }
    }
}

/// A non-fatal warning surfaced alongside successful validation results.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ValidationWarning {
    pub field: String,
    pub message: String,
}

impl ValidationWarning {
    pub fn new(field: impl Into<String>, message: impl Into<String>) -> Self {
        Self {
            field: field.into(),
            message: message.into(),
        }
    }
}

/// Informational metadata about absent optional/recommended fields.
/// Produced only when callers request `show_missing_optional`.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ValidationInfo {
    pub field: String,
    pub message: String,
}

impl ValidationInfo {
    pub fn new(field: impl Into<String>, message: impl Into<String>) -> Self {
        Self {
            field: field.into(),
            message: message.into(),
        }
    }
}

pub type Result<T> = std::result::Result<T, XarfError>;