Struct ToolSpec 

pub struct ToolSpec { /* private fields */ }

Portable specification separated from tool executor behavior.

Implementations

impl ToolSpec

pub fn new( name: ToolName, version: ToolVersion, description: impl Into<String>, input_schema: Value, output_schema: Value, effects: impl IntoIterator<Item = ToolEffect>, execution: ToolExecutionSemantics, ) -> Result<Self, ToolSpecError>

Creates a validated portable tool specification.

Errors

Returns an error for invalid text, schemas, effects, or unsafe execution semantics.

pub fn with_source(self, source: ToolSource) -> Self

Replaces the default native provenance with one validated frozen source.

pub fn with_label(self, label: impl Into<String>) -> Result<Self, ToolSpecError>

Adds a bounded human-readable label kept out of model tool definitions.

Errors

Returns an error for empty, oversized, or null-containing text.

pub fn with_prompt_hint( self, hint: impl Into<String>, ) -> Result<Self, ToolSpecError>

Adds a bounded model prompt hint.

Errors

Returns an error for empty, oversized, or null-containing text.

pub fn with_prompt_snippet( self, snippet: impl Into<String>, ) -> Result<Self, ToolSpecError>

Adds one bounded model prompt snippet.

Errors

Returns an error for empty, oversized, or null-containing text.

pub fn with_prompt_guidelines<I, S>( self, guidelines: I, ) -> Result<Self, ToolSpecError>

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

Adds bounded model prompt guidelines.

Errors

Returns an error when a guideline is invalid or the collection exceeds its documented bounds.

pub fn with_ui_renderer( self, renderer: impl Into<String>, ) -> Result<Self, ToolSpecError>

Adds a bounded renderer selector with no UI implementation dependency.

Errors

Returns an error when the selector is not canonical.

pub fn to_model_definition(&self) -> Result<ModelToolDefinition, ToolSpecError>

Projects this specification into the model-facing tool contract.

Errors

Returns an error if model-layer bounds are stricter than this contract.

pub fn scheduler_class(&self) -> SchedulerClass

Derives conservative scheduler behavior from metadata only.

pub const fn name(&self) -> &ToolName

Returns the stable tool name.

pub const fn version(&self) -> &ToolVersion

Returns the semantic contract version.

pub fn label(&self) -> Option<&str>

Returns the optional human-readable label.

pub fn description(&self) -> &str

Returns the model-visible description.

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

Returns the input object schema.

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

Returns the output object schema.

pub fn effects(&self) -> &[ToolEffect]

Returns sorted, deduplicated effects.

pub const fn source(&self) -> &ToolSource

Returns frozen provider-neutral tool provenance.

pub const fn execution(&self) -> ToolExecutionSemantics

Returns execution semantics.

pub fn prompt_hint(&self) -> Option<&str>

Returns the optional model prompt hint.

pub fn prompt_snippet(&self) -> Option<&str>

Returns the optional model prompt snippet.

pub fn prompt_guidelines(&self) -> &[String]

Returns bounded model prompt guidelines in declaration order.

pub fn ui_renderer(&self) -> Option<&str>

Returns the optional UI renderer selector.

Trait Implementations

impl Clone for ToolSpec

fn clone(&self) -> ToolSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSpec

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

Formats the value using the given formatter.

impl PartialEq for ToolSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ToolSpec