Skip to main content

Schema

Struct Schema 

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

A schema for validating top-level JSON objects.

Implementations§

Source§

impl Schema

Source

pub fn new() -> Self

Create a new schema.

Source

pub fn field( self, name: impl Into<String>, validator: impl Validator + 'static, ) -> Self

Add a field validator.

Source

pub fn strict(self, strict: bool) -> Self

Enable or disable strict mode.

When strict, keys present in the input object but absent from the schema produce an Unknown field error.

Source

pub fn fail_fast(self, fail_fast: bool) -> Self

Stop at the first validation error.

When enabled, validation returns a result containing exactly one error. The flag is propagated to nested validators.

Source

pub fn validate(&self, data: &Value) -> ValidationResult

Validate a JSON object (serde_json::Value object).

Source

pub fn validate_or_raise(&self, data: &Value) -> Result<(), ValidationResult>

Validate and return Ok(()) if valid, or the full result on failure.

Source

pub fn try_validate(&self, data: &Value) -> Result<(), ValidationErrors>

Validate and return Ok(()) if valid, or a ValidationErrors aggregate (which implements std::error::Error) on failure.

Trait Implementations§

Source§

impl Default for Schema

Source§

fn default() -> Self

Returns the “default value” for a type. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.