Struct Tool 

pub struct Tool {
    pub version: String,
    pub requires_filesystem: bool,
    pub commands: CommandTree,
    pub schema: SchemaGraph,
}

Top-level tool metadata record.

Fields

version: String

requires_filesystem: bool

commands: CommandTree

schema: SchemaGraph

Named-type registry shared by this tool’s commands. Typed positions in the command tree may reference these definitions via SchemaType::Ref. Use SchemaGraph::empty when there are no shared definitions to declare.

The graph’s root field is a structurally-required placeholder (empty record); only defs is consumed. The real roots are the per-position embedded SchemaTypes.

Implementations

impl Tool

pub fn command_index_by_path(&self, command_path: &[String]) -> Option<usize>

Resolves a command-path (as passed to golem:tool invoke) to the index of the command node whose body it selects. An empty path selects the root command. Each segment matches a subcommand’s name or alias. Returns None when a segment does not match or the selected command has no body.

pub fn effective_globals( &self, command_index: usize, ) -> Vec<EffectiveCommandField>

The inherited globals in scope for command_index, collected along the path from the root in path order (options before flags within each node).

pub fn canonical_input_surfaces( &self, command_index: usize, ) -> Vec<CanonicalSurfaceRef>

The ordered canonical input surfaces of the command at command_index, identified by their position in the tool definition (see the module documentation for the ordering and shadowing rules).

This is the single source of the canonical field ordering: callers with richer per-surface data (such as the Rust SDK’s extended descriptor model) map each returned reference back onto their own structures by position, which stays unambiguous even for invalid tools with duplicate surface names.

pub fn canonical_field_for_surface( &self, command_index: usize, surface: CanonicalSurfaceRef, ) -> Option<CanonicalInputField>

The canonical input field for one surface reference of the command at command_index, or None if the reference does not resolve.

pub fn canonical_input_fields( &self, command_index: usize, ) -> Vec<CanonicalInputField>

The ordered canonical input fields of the command at command_index (see the module documentation for the ordering and shadowing rules).

pub fn canonical_input_model( &self, command_index: usize, ) -> Result<CanonicalInputModel, ToolValidationError>

The canonical input model of the command at command_index: the ordered fields plus the self-contained record schema.

pub fn canonical_input_record_schema( &self, command_index: usize, ) -> Result<SchemaGraph, ToolValidationError>

The self-contained record schema of the command’s canonical input: a record with one field per canonical input field, with the tool’s shared definitions projected to those reachable from the record.

pub fn decode_canonical_input_record( &self, command_index: usize, value: SchemaValue, ) -> Result<Vec<CanonicalInputValue>, CanonicalInputDecodeError>

Decodes a canonical input record value against the command’s canonical input model.

impl Tool

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

Returns the name of the tool: the name of the root node of its command tree.

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromSchema for Tool

fn from_value(value: &SchemaValue) -> Result<Tool, FromSchemaError>

impl IntoSchema for Tool

fn type_id() -> TypeId

fn register_in(builder: &mut SchemaBuilder) -> SchemaType

fn to_value(&self) -> SchemaValue

impl PartialEq for Tool

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Tool

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Tool

impl TryFrom<&Tool> for Tool

fn try_from(tool: &Tool) -> Result<Tool, <Tool as TryFrom<&Tool>>::Error>

Encode a Tool into the flat golem:tool/common@0.1.0 wire form. The tool’s defs plus every type embedded in its command tree are folded into one shared wire::SchemaGraph.

type Error = ToolWitError

The type returned in the event of a conversion error.

impl TryFrom<&Tool> for Tool

fn try_from(w: &Tool) -> Result<Tool, <Tool as TryFrom<&Tool>>::Error>

Decode a golem:tool/common@0.1.0 wire wire::Tool into the recursive Tool model.

type Error = ToolWitError

The type returned in the event of a conversion error.