invr 0.2.1

Declarative data validation engine using invariants executed on Polars DataFrames.
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

use std::{error::Error, fmt};

use crate::invariant::value_object::id::InvariantId;

#[derive(Debug, Clone, PartialEq)]
pub enum ViolationError {
    EmptyReason {
        invariant_id: InvariantId,
    },
    MissingMetric {
        invariant_id: InvariantId,
        name: String,
    },
    DuplicateMetric {
        invariant_id: InvariantId,
        name: String,
    },
}

impl ViolationError {
    pub fn empty_reason(invariant_id: InvariantId) -> Self {
        Self::EmptyReason { invariant_id }
    }

    pub fn missing_metric(invariant_id: InvariantId, name: impl Into<String>) -> Self {
        Self::MissingMetric {
            invariant_id,
            name: name.into(),
        }
    }

    pub fn duplicate_metric(invariant_id: InvariantId, name: impl Into<String>) -> Self {
        Self::DuplicateMetric {
            invariant_id,
            name: name.into(),
        }
    }
}

impl fmt::Display for ViolationError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ViolationError::EmptyReason { invariant_id } => {
                write!(
                    f,
                    "violation for invariant '{}' has an empty reason",
                    invariant_id.as_str()
                )
            }
            ViolationError::MissingMetric { invariant_id, name } => {
                write!(
                    f,
                    "violation for invariant '{}' is missing required metric '{}'",
                    invariant_id.as_str(),
                    name
                )
            }
            ViolationError::DuplicateMetric { invariant_id, name } => {
                write!(
                    f,
                    "violation for invariant '{}' already contains metric '{}'",
                    invariant_id.as_str(),
                    name
                )
            }
        }
    }
}

impl Error for ViolationError {}

pub type ViolationResult<T> = Result<T, ViolationError>;