Skip to main content

CompiledSchema

Struct CompiledSchema 

Source
pub struct CompiledSchema { /* private fields */ }
Expand description

Compiled JSON Schema for efficient repeated validation

Compiling a schema is relatively expensive, so this type caches the compiled schema for efficient reuse.

§Thread Safety

CompiledSchema uses Arc internally and is safe to share across threads.

§Examples

use hedl_json::validation::{CompiledSchema, ValidationConfig};
use serde_json::json;

let schema = json!({
    "type": "object",
    "properties": {
        "id": {"type": "integer"}
    }
});

let compiled = CompiledSchema::compile(&schema, &ValidationConfig::default())?;

// Validate multiple documents efficiently
let doc1 = json!({"id": 1});
let doc2 = json!({"id": 2});

assert!(compiled.validate(&doc1).is_valid);
assert!(compiled.validate(&doc2).is_valid);

Implementations§

Source§

impl CompiledSchema

Source

pub fn compile( schema: &JsonValue, config: &ValidationConfig, ) -> Result<Self, SchemaError>

Compile a JSON Schema for validation

§Arguments
  • schema - JSON Schema document as a serde_json::Value
  • config - Validation configuration
§Returns
  • Ok(CompiledSchema) - Successfully compiled schema
  • Err(SchemaError) - Schema is invalid
§Examples
use hedl_json::validation::{CompiledSchema, ValidationConfig};
use serde_json::json;

let schema = json!({
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "string",
    "minLength": 1
});

let compiled = CompiledSchema::compile(&schema, &ValidationConfig::default())?;
Source

pub fn validate(&self, instance: &JsonValue) -> ValidationResult

Validate a JSON value against the schema

§Arguments
  • instance - JSON document to validate
§Returns

ValidationResult with validation outcome and any errors

§Examples
use hedl_json::validation::{CompiledSchema, ValidationConfig};
use serde_json::json;

let schema = json!({"type": "integer"});
let compiled = CompiledSchema::compile(&schema, &ValidationConfig::default())?;

let result = compiled.validate(&json!(42));
assert!(result.is_valid);

let result = compiled.validate(&json!("not an integer"));
assert!(!result.is_valid);
Source

pub fn is_valid(&self, instance: &JsonValue) -> bool

Check if a JSON value is valid without collecting errors

This is faster than validate() when you only need to know whether the document is valid.

§Arguments
  • instance - JSON document to validate
§Returns

true if valid, false otherwise

Trait Implementations§

Source§

impl Clone for CompiledSchema

Source§

fn clone(&self) -> CompiledSchema

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CompiledSchema

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more