Module schema 

VSF Schema System - Type-safe section and field validation

This module provides schema definitions for VSF sections, enabling:

• Type-safe section builders with Rust-native syntax
• Field validation against allowed values
• Round-trip parsing: VSF → Struct → VSF
• Automatic error messages for invalid fields

Architecture

• SectionSchema: Defines allowed fields for a section type
• FieldSchema: Defines field name, type constraints, validation rules
• SchemaRegistry: Registry of official VSF section types
• UserRegistry: Registry for application-specific sections

Design Principles

1. Order Independence: Field order doesn’t matter (except z, y, b in header)
2. Parse → Modify → Encode: Support round-trip modifications
3. Compile-time Safety: Use Rust type system where possible
4. Runtime Validation: Schema enforcement for dynamic sections

Example

// Define schema let image_schema = SectionSchema::new("image") .field("iso", FieldType::U16) .field("shutter_speed", FieldType::F32) .field("aperture", FieldType::F32);

// Build section with validation let section = image_schema.build() .set("iso", 400)? .set("shutter_speed", 1.0/125.0)? .set("aperture", 2.8)? .encode()?;

// Parse and validate let parsed = image_schema.parse(&bytes)?; assert_eq!(parsed.get::<u16>("iso")?, 400);

Re-exports

pub use constraint::TypeConstraint;

pub use conversions::AsciiText;

pub use conversions::FromVsfType;

pub use conversions::IntoVsfType;

pub use field::FieldSchema;

pub use official::pipe_message_schema;

pub use official::register_official_schemas;

pub use registry::SchemaRegistry;

pub use registry::UserRegistry;

pub use section::FieldValue;

pub use section::SectionBuilder;

pub use section::SectionSchema;

pub use validate::ValidationError;

pub use validate::ValidationResult;

Modules

constraint

Type constraints for VSF schema validation

conversions

Type conversions between Rust primitives and VsfType

field

Field schema definitions using TypeConstraint

official

Official VSF section schemas

prelude

Prelude for common schema operations

registry

SchemaRegistry singleton — gated behind the registry feature because it depends on spin (which requires atomic CAS, unavailable on e.g. Cortex-M0+). Embedded callers that only need the per-schema builder/parser (no global lookup) can omit registry and still use bridge_cmd_schema(), SectionBuilder::parse, etc. Schema registries for official and user-defined sections (stub implementation)

section

Section schema and builder with named field encoding

validate

Validation error types and results