Skip to main content

JsonSchema

Enum JsonSchema 

Source
pub enum JsonSchema {
    Any,
    Null,
    Bool,
    Number,
    StringType,
    ArrayOf(Box<JsonSchema>),
    ObjectWith {
        required: Vec<(String, JsonSchema)>,
        allow_extra: bool,
    },
}
Expand description

Simple JSON schema for validation.

Variants§

§

Any

Any value is accepted.

§

Null

Must be null.

§

Bool

Must be a boolean.

§

Number

Must be a number.

§

StringType

Must be a string.

§

ArrayOf(Box<JsonSchema>)

Must be an array where each element matches the inner schema.

§

ObjectWith

Must be an object with the specified required fields.

Fields

§required: Vec<(String, JsonSchema)>

Required fields: (key, schema).

§allow_extra: bool

Whether additional fields are allowed.

Implementations§

Source§

impl JsonSchema

Source

pub fn validate(&self, value: &JsonValue) -> Result<(), String>

Validate a JSON value against this schema. Returns Ok(()) or an error message.

Source§

impl JsonSchema

Source

pub fn infer_from(value: &JsonValue) -> Self

Infer a JsonSchema from a sample value.

Arrays use the schema of their first element; objects use the schemas of their values.

Source

pub fn to_schema_string(&self) -> String

Serialize the schema to a human-readable string.

Source

pub fn to_json_schema_object(&self) -> JsonValue

Generate a JSON Schema draft-07 compatible object.

Trait Implementations§

Source§

impl Clone for JsonSchema

Source§

fn clone(&self) -> JsonSchema

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for JsonSchema

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, 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.