Struct ToolSchema 

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

Machine-validatable JSON Schema for tool input or output.

Implementations

impl ToolSchema

pub fn new(value: Json) -> AppResult<Self>

Create a schema from a JSON object value.

pub fn any_object() -> Self

Create the permissive object schema used for tools without typed params.

pub const fn as_json(&self) -> &Json

Borrow the underlying JSON Schema document.

pub fn as_object(&self) -> Option<&Map<String, Json>>

Borrow this schema as a JSON object.

pub fn is_object(&self) -> bool

Return whether this schema is represented by a JSON object.

pub fn into_json(self) -> Json

Consume this wrapper and return the JSON Schema document.

Trait Implementations

impl Clone for ToolSchema

fn clone(&self) -> ToolSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSchema

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

Formats the value using the given formatter.

impl Default for ToolSchema

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolSchema

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToolSchema

impl PartialEq for ToolSchema

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolSchema

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 ToolSchema

impl TryFrom<Value> for ToolSchema

type Error = AppError

The type returned in the event of a conversion error.

fn try_from(value: Json) -> Result<Self, Self::Error>

Performs the conversion.