Skip to main content

SchemaEngine

Struct SchemaEngine 

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

Engine for applying runtime transforms to tool schemas.

Schemars derive generates base schemas at compile time. SchemaEngine applies transforms at runtime for provider flexibility.

§Clone behavior

When cloned, custom_transforms are not carried over (they are not Clone). Only per_tool constraints and global_strict settings are cloned.

Implementations§

Source§

impl SchemaEngine

Source

pub fn new() -> Self

Create a new schema engine.

Source

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

Enable strict mode (additionalProperties=false) globally.

Source

pub fn is_strict(&self) -> bool

Get global strict mode setting.

Source

pub fn constrain_field( &mut self, tool: &str, json_path: Vec<String>, c: FieldConstraint, )

Add a field constraint for a specific tool.

The json_path is a list of property names to traverse to reach the field. For example, ["properties", "count"] would target the “count” property.

Source

pub fn add_transform<T: SchemaTransform + 'static>(&mut self, transform: T)

Add a custom transform.

Source

pub fn transform(&self, tool: &str, schema: Schema) -> Schema

Transform a tool’s schema applying all constraints and transforms.

Trait Implementations§

Source§

impl Clone for SchemaEngine

Source§

fn clone(&self) -> Self

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 SchemaEngine

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SchemaEngine

Source§

fn default() -> SchemaEngine

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> 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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.