vsf 0.3.4

Versatile Storage Format
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

//! Field schema definitions using TypeConstraint
//!
//! Defines how fields within VSF sections are validated using type constraints
//! rather than parallel type enums. This ensures complete coverage of all VsfType
//! variants without duplication.

use super::constraint::{vsf_type_name, TypeConstraint};
use super::validate::ValidationResult;
use crate::VsfType;

/// Schema definition for a field within a section
///
/// Fields are validated using TypeConstraint which pattern-matches against
/// VsfType variants rather than duplicating the type system.
#[derive(Clone)]
pub struct FieldSchema {
    pub name: String,
    pub constraint: TypeConstraint,
    pub required: bool,
    pub description: Option<String>,
    pub default: Option<VsfType>,
}

impl FieldSchema {
    /// Create a new field schema with a type constraint
    pub fn new(name: impl Into<String>, constraint: TypeConstraint) -> Self {
        Self {
            name: name.into(),
            constraint,
            required: false,
            description: None,
            default: None,
        }
    }

    /// Mark field as required
    pub fn required(mut self) -> Self {
        self.required = true;
        self
    }

    /// Add description
    pub fn description(mut self, desc: impl Into<String>) -> Self {
        self.description = Some(desc.into());
        self
    }

    /// Set default value (automatically marks field as optional)
    pub fn default(mut self, value: VsfType) -> Self {
        self.default = Some(value);
        self.required = false;
        self
    }

    /// Validate a VsfType against this field schema
    pub fn validate(&self, value: &VsfType) -> ValidationResult<()> {
        self.constraint.validate(value)
    }
}

impl std::fmt::Debug for FieldSchema {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("FieldSchema")
            .field("name", &self.name)
            .field("constraint", &self.constraint)
            .field("required", &self.required)
            .field("description", &self.description)
            .field("default", &self.default.as_ref().map(vsf_type_name))
            .finish()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_field_schema_creation() {
        let field = FieldSchema::new("width", TypeConstraint::AnyUnsigned)
            .required()
            .description("Image width in pixels");

        assert_eq!(field.name, "width");
        assert!(field.required);
        assert_eq!(field.description, Some("Image width in pixels".to_string()));
    }

    #[test]
    fn test_field_validation() {
        let field = FieldSchema::new("count", TypeConstraint::AnyUnsigned);

        // Should accept unsigned integers
        assert!(field.validate(&VsfType::u5(42)).is_ok());
        assert!(field.validate(&VsfType::u3(10)).is_ok());

        // Should reject non-unsigned
        assert!(field.validate(&VsfType::f6(3.14)).is_err());
        assert!(field.validate(&VsfType::x("hello".to_string())).is_err());
    }

    #[test]
    fn test_field_with_default() {
        let field =
            FieldSchema::new("timeout", TypeConstraint::AnyUnsigned).default(VsfType::u5(30));

        assert!(!field.required); // default() makes it optional
        assert!(field.default.is_some());
    }
}