Struct SchemaBuilder 

pub struct SchemaBuilder { /* private fields */ }

A fluent builder for constructing JSON Schemas.

Example

use mcpkit_core::schema::SchemaBuilder;

let schema = SchemaBuilder::object()
    .title("SearchInput")
    .description("Input for search tool")
    .property("query", SchemaBuilder::string().min_length(1))
    .property("page", SchemaBuilder::integer().minimum(1).default_value(1))
    .required(["query"])
    .build();

Implementations

impl SchemaBuilder

pub fn new() -> Self

Create a new schema builder.

pub fn string() -> Self

Create a string schema builder.

pub fn number() -> Self

Create a number schema builder.

pub fn integer() -> Self

Create an integer schema builder.

pub fn boolean() -> Self

Create a boolean schema builder.

pub fn array() -> Self

Create an array schema builder.

pub fn object() -> Self

Create an object schema builder.

pub fn null() -> Self

Create a null schema builder.

pub fn title(self, title: impl Into<String>) -> Self

Set the schema title.

pub fn description(self, description: impl Into<String>) -> Self

Set the schema description.

pub fn default_value(self, default: impl Into<Value>) -> Self

Set the default value.

pub fn enum_values<I, V>(self, values: I) -> Self

where I: IntoIterator<Item = V>, V: Into<Value>,

Set enumerated allowed values.

pub fn const_value(self, value: impl Into<Value>) -> Self

Set a constant value.

pub const fn min_length(self, min: u64) -> Self

Set minimum string length.

pub const fn max_length(self, max: u64) -> Self

Set maximum string length.

pub fn pattern(self, pattern: impl Into<String>) -> Self

Set regex pattern.

pub fn format(self, format: impl Into<String>) -> Self

Set string format hint.

pub fn minimum(self, min: impl Into<f64>) -> Self

Set minimum value (inclusive).

pub fn maximum(self, max: impl Into<f64>) -> Self

Set maximum value (inclusive).

pub fn exclusive_minimum(self, min: impl Into<f64>) -> Self

Set exclusive minimum value.

pub fn exclusive_maximum(self, max: impl Into<f64>) -> Self

Set exclusive maximum value.

pub fn multiple_of(self, multiple: impl Into<f64>) -> Self

Set multiple-of constraint.

pub fn items(self, items: Self) -> Self

Set schema for array items.

pub const fn min_items(self, min: u64) -> Self

Set minimum number of items.

pub const fn max_items(self, max: u64) -> Self

Set maximum number of items.

pub const fn unique_items(self, unique: bool) -> Self

Require unique items.

pub fn property(self, name: impl Into<String>, schema: Self) -> Self

Add a property to the schema.

pub fn required<I, S>(self, required: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set required properties.

pub fn additional_properties(self, allowed: bool) -> Self

Set whether additional properties are allowed.

pub fn additional_properties_schema(self, schema: Self) -> Self

Set schema for additional properties.

pub const fn min_properties(self, min: u64) -> Self

Set minimum number of properties.

pub const fn max_properties(self, max: u64) -> Self

Set maximum number of properties.

pub fn all_of<I>(self, schemas: I) -> Self

where I: IntoIterator<Item = Self>,

Require all of the given schemas to match.

pub fn any_of<I>(self, schemas: I) -> Self

where I: IntoIterator<Item = Self>,

Require any of the given schemas to match.

pub fn one_of<I>(self, schemas: I) -> Self

where I: IntoIterator<Item = Self>,

Require exactly one of the given schemas to match.

pub fn not(self, schema: Self) -> Self

Require the given schema to not match.

pub fn build(self) -> Schema

Build the schema.

pub fn to_value(self) -> Value

Build and convert to a JSON value.

Trait Implementations

impl Clone for SchemaBuilder

fn clone(&self) -> SchemaBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaBuilder

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

Formats the value using the given formatter.

impl Default for SchemaBuilder

fn default() -> SchemaBuilder

Returns the “default value” for a type.