Struct Schema 

pub struct Schema { /* private fields */ }

JSON Schema-backed message contract for a channel.

Implementations

impl Schema

pub fn new(definition: Value) -> Result<Self, SchemaValidationError>

Builds a schema from a JSON Schema definition.

Errors

Returns SchemaValidationError::InvalidSchema when the definition cannot be compiled.

pub fn with_id( id: SchemaId, definition: Value, ) -> Result<Self, SchemaValidationError>

Builds a schema from a JSON Schema definition with an explicit identifier.

Errors

Returns SchemaValidationError::InvalidSchema when the definition cannot be compiled.

pub const fn id(&self) -> SchemaId

Returns the schema version identifier.

pub fn definition(&self) -> &Value

Returns the wrapped JSON Schema definition.

pub fn validate<Payload>( &self, payload: Payload, ) -> Result<(), SchemaValidationError>

where Payload: AsRef<[u8]>,

Validates JSON payload bytes after applying known schema defaults.

Errors

Returns SchemaValidationError when the payload is not JSON, cannot receive required defaults, or does not match this schema.

pub fn validate_and_apply_defaults<Payload>( &self, payload: Payload, ) -> Result<Vec<u8>, SchemaValidationError>

where Payload: AsRef<[u8]>,

Validates payload bytes and returns the normalized JSON bytes to deliver.

Errors

Returns SchemaValidationError when the payload cannot be parsed, normalized, validated, or serialized for delivery.

pub fn evolve_add_field( &self, name: impl Into<String>, field_schema: Value, default: Value, ) -> Result<Self, SchemaValidationError>

Evolves an object schema by adding a required field with a default value.

Errors

Returns SchemaValidationError when this is not an object schema, the field schema is invalid, the default does not match the field schema, or the evolved schema cannot compile.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Schema

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.