molten-document 0.0.2

Document schema definitions, field types, and validation for Molten
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

//! Defines error types specific to document validation within the `molten-document` crate.
//!
//! This module provides a comprehensive set of error variants encapsulated by
//! `DocumentValidationError`, each detailing specific reasons why a document
//! might fail validation against its `FormDefinition`.
use serde::{Deserialize, Serialize};
use thiserror::Error;

/// Represents errors encountered during the document validation process.
#[derive(Error, Debug, PartialEq, Serialize, Deserialize)]
pub enum DocumentValidationError {
    /// Indicates that a required field was missing from the document or its value was null.
    #[error("Field '{0}' is required but was missing or null")]
    MissingRequiredField(String),

    /// Indicates a type mismatch for a field's value.
    #[error("Field '{field_id}' expected type '{expected_type}', but got '{got_type}'")]
    InvalidType {
        /// The ID of the field that had an invalid type.
        field_id: String,
        /// The expected data type for the field.
        expected_type: String,
        /// The actual data type received for the field.
        got_type: String,
    },

    /// Indicates that a numerical field's value is below its specified minimum.
    #[error("Field '{field_id}' value {value} is less than minimum {min}")]
    ValueTooLow {
        /// The ID of the numerical field.
        field_id: String,
        /// The value that was too low.
        value: f64,
        /// The minimum allowed value for the field.
        min: f64,
    },

    /// Indicates that a numerical field's value is above its specified maximum.
    #[error("Field '{field_id}' value {value} is greater than maximum {max}")]
    ValueTooHigh {
        /// The ID of the numerical field.
        field_id: String,
        /// The value that was too high.
        value: f64,
        /// The maximum allowed value for the field.
        max: f64,
    },

    /// Indicates that a selection field's value is not among the allowed options.
    #[error("Field '{field_id}' value '{value}' is not a valid option. Allowed: {allowed:?}")]
    InvalidSelection {
        /// The ID of the selection field.
        field_id: String,
        /// The invalid value received.
        value: String,
        /// The list of allowed options for the field.
        allowed: Vec<String>,
    },

    /// Indicates that a date/time field's value is not in a valid ISO 8601 format.
    #[error("Field '{field_id}' expected a date string (ISO 8601), but got '{value}'")]
    InvalidDateFormat {
        /// The ID of the date field.
        field_id: String,
        /// The invalid date string received.
        value: String,
    },

    /// Indicates that the document's `form_id` does not match the `FormDefinition`'s ID.
    #[error("Document form_id '{doc_form}' does not match definition id '{def_id}'")]
    FormIdMismatch {
        /// The `form_id` specified in the document.
        doc_form: String,
        /// The `id` specified in the `FormDefinition`.
        def_id: String,
    },
}