Struct RefSchema 

pub struct RefSchema { /* private fields */ }

A schema that references another schema by name.

RefSchema enables schema reuse and recursive structures by referencing schemas stored in a registry. During validation, the reference is resolved to the actual schema.

References can only be validated through a registry using SchemaRegistry::validate(). Attempting to validate without a registry produces an error.

Example

use postmortem::{Schema, SchemaRegistry};
use serde_json::json;

let registry = SchemaRegistry::new();

// Register a base schema
registry.register("UserId", Schema::integer().positive()).unwrap();

// Use a reference in another schema
registry.register("User", Schema::object()
    .field("id", Schema::ref_("UserId"))
    .field("name", Schema::string())
).unwrap();

let result = registry.validate("User", &json!({
    "id": 42,
    "name": "Alice"
})).unwrap();

assert!(result.is_success());

Implementations

impl RefSchema

pub fn new(name: impl Into<String>) -> Self

Creates a new schema reference.

This is typically called via Schema::ref_() rather than directly.

pub fn name(&self) -> &str

Returns the name of the referenced schema.

Trait Implementations

impl SchemaLike for RefSchema

type Output = Value

The output type produced by successful validation.

fn validate( &self, _value: &Value, path: &JsonPath, ) -> Validation<Value, SchemaErrors>

Validates a value against this schema.

fn validate_to_value( &self, value: &Value, path: &JsonPath, ) -> Validation<Value, SchemaErrors>

Validates a value and returns the result as a serde_json::Value.

fn validate_with_context( &self, value: &Value, path: &JsonPath, context: &ValidationContext, ) -> Validation<Value, SchemaErrors>

Validates a value with registry context for schema reference resolution.

fn validate_to_value_with_context( &self, value: &Value, path: &JsonPath, context: &ValidationContext, ) -> Validation<Value, SchemaErrors>

Validates a value with context and returns the result as a serde_json::Value.

fn collect_refs(&self, refs: &mut Vec<String>)

Collects all schema reference names used by this schema.