Struct JsonSchema 

pub struct JsonSchema(/* private fields */);

Validated strict object JSON schema.

Examples

use providers_kit::generation::JsonSchema;
let schema = JsonSchema::new(
    serde_json::json!({"type":"object", "properties":{"answer":{"type":"string"}}}),
)?;
assert_eq!(schema.schema()["type"], "object");

Implementations

impl JsonSchema

pub fn new(schema: Value) -> Result<Self, KitError>

Validates and owns an object-shaped JSON schema.

Errors

Returns an input error unless the schema is a JSON object whose root declares type: object. The selected operation performs any stricter schema or provider validation.

See crate::generation::JsonSchema for a complete example.

pub const fn schema(&self) -> &Value

Borrows the validated schema document.

See crate::generation::JsonSchema for a complete example.

pub fn into_value(self) -> Value

Consumes the wrapper and returns the schema document.

Examples

use providers_kit::generation::JsonSchema;
let schema = JsonSchema::new(
    serde_json::json!({"type":"object", "properties":{"answer":{"type":"string"}}}),
)?;
assert_eq!(schema.into_value()["type"], "object");

Trait Implementations

impl Clone for JsonSchema

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JsonSchema

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for JsonSchema

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for JsonSchema

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for JsonSchema