Trait CustomTypeSchema

Source

pub trait CustomTypeSchema {
    // Required method
    fn schema_type() -> &'static str;

    // Provided methods
    fn schema_format() -> Option<&'static str> { ... }
    fn schema_description() -> Option<String> { ... }
    fn schema_additional_properties() -> Option<Value> { ... }
    fn json_schema() -> Value { ... }
}

Expand description

Trait for types that can provide their own JSON Schema representation

This trait should be implemented for custom types that don’t have a direct JSON representation but can be serialized to JSON, such as dates, UUIDs, and other special types.

§Examples

use rstructor::schema::CustomTypeSchema;
use serde_json::json;
use serde::{Serialize, Deserialize};

// Create a custom date type
#[derive(Serialize, Deserialize)]
struct MyCustomDate {
    year: u16,
    month: u8,
    day: u8,
}

// Implement CustomTypeSchema for our custom date type
impl CustomTypeSchema for MyCustomDate {
    fn schema_type() -> &'static str {
        "string"
    }
     
    fn schema_format() -> Option<&'static str> {
        Some("date-time")
    }
     
    fn schema_description() -> Option<String> {
        Some("ISO-8601 formatted date and time".to_string())
    }
}