Skip to main content

ValueSchema

Enum ValueSchema 

Source
pub enum ValueSchema {
    Number {
        kind: NumberKind,
    },
    Bool,
    Text {
        max_len: Option<usize>,
    },
    Enum {
        variants: Vec<String>,
    },
    Array {
        items: Box<ValueSchema>,
        min_len: Option<usize>,
        max_len: Option<usize>,
    },
    Record {
        fields: Vec<FieldSchema>,
        allow_extra: bool,
    },
    Quantity {
        dimension: Option<Dimension>,
        allow_delta: bool,
    },
    Money,
    Matrix {
        max_elems: Option<usize>,
        square: bool,
    },
    Expression {
        variables: Vec<String>,
    },
    Bound,
    Any,
}
Expand description

The schema of a single value.

Variants§

§

Number

Fields

§

Bool

§

Text

Fields

§max_len: Option<usize>
§

Enum

Fields

§variants: Vec<String>
§

Array

Fields

§min_len: Option<usize>
§max_len: Option<usize>
§

Record

Fields

§allow_extra: bool
§

Quantity

Fields

§dimension: Option<Dimension>
§allow_delta: bool

Whether a temperature-difference style quantity is accepted.

§

Money

§

Matrix

Fields

§max_elems: Option<usize>
§square: bool
§

Expression

A restricted expression string, parsed by the engine before invocation.

Fields

§variables: Vec<String>
§

Bound

§

Any

Implementations§

Source§

impl ValueSchema

Source

pub fn number(kind: NumberKind) -> ValueSchema

Source

pub fn exact() -> ValueSchema

Source

pub fn float64() -> ValueSchema

Source

pub fn text() -> ValueSchema

Source

pub fn array(items: ValueSchema) -> ValueSchema

Source

pub fn array_with_len( items: ValueSchema, min_len: usize, max_len: Option<usize>, ) -> ValueSchema

Source

pub fn validate( &self, value: &Value, path: &str, limits: &Limits, ) -> Result<(), EngineError>

Validate an already-typed value.

Source

pub fn coerce( &self, raw: &Value, path: &str, limits: &Limits, numeric_shorthand: bool, ) -> Result<Value, EngineError>

Coerce raw JSON into a typed value, applying the documented shorthand rules: JSON integers/decimals are exact, and when numeric_shorthand is true a string is parsed as a numeric literal for numeric schemas.

Source

pub fn is_numeric(&self) -> bool

True when this schema accepts exact numeric payloads and therefore may receive string shorthand in expressions/requests.

Source

pub fn summary(&self) -> String

A short human-readable description, used in generated documentation.

Source

pub fn to_json_schema(&self) -> Value

Convert to a JSON-schema-like description used in MCP tool definitions.

Trait Implementations§

Source§

impl Clone for ValueSchema

Source§

fn clone(&self) -> ValueSchema

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 ValueSchema

Source§

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

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

impl<'de> Deserialize<'de> for ValueSchema

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ValueSchema

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ValueSchema

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ValueSchema

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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<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 = !

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.