Struct Tool 

pub struct Tool {
    pub symbol: Symbol,
    pub description: String,
    pub args_shape: ShapeRef,
    pub result_shape: Option<ShapeRef>,
    pub category: Symbol,
    pub capabilities: Vec<CapabilityName>,
    pub function: Value,
    /* private fields */
}

A callable tool an agent can invoke, with shape-checked arguments and results, a category, and required capabilities.

Fields

symbol: Symbol

The tool’s name.

description: String

Human-readable description of what the tool does.

args_shape: ShapeRef

Shape the argument list is checked against before invocation.

result_shape: Option<ShapeRef>

Optional shape the result is checked against after invocation.

category: Symbol

Category grouping this tool with related tools.

capabilities: Vec<CapabilityName>

Capabilities required to invoke the tool.

function: Value

The underlying callable that implements the tool.

Implementations

impl Tool

pub fn local(cx: &mut Cx, spec: ToolSpec) -> Self

Builds a local tool from a ToolSpec, binding installed codecs.

Trait Implementations

impl Callable for Tool

fn call(&self, cx: &mut Cx, args: Args) -> Result<Value>

Invoke the callable with already-evaluated, checked Args.

fn browse_args_shape(&self, _cx: &mut Cx) -> Result<Option<Value>, Error>

Optional shape describing the accepted argument list, for browsing.

fn browse_result_shape(&self, _cx: &mut Cx) -> Result<Option<Value>, Error>

Optional shape describing the call result, for browsing.

fn call_exprs(&self, cx: &mut Cx, args: RawArgs) -> Result<Value, Error>

Invoke the callable on raw, unevaluated argument expressions.

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 Component for Tool

fn kind(&self) -> ComponentKind

Returns the kind of component this is.

fn name(&self) -> &Symbol

Returns the component’s name symbol.

fn capabilities(&self) -> &[CapabilityName]

Returns the capabilities this component requires or grants.

fn reflect(&self, cx: &mut Cx) -> Result<Expr>

Produces a self-describing expression for inspection of this component.

impl EvalSite for Tool

fn site_kind(&self) -> &'static str

Returns a short label naming the kind of site.

fn address(&self) -> &ServerAddress

Returns the address this site answers at.

fn codecs(&self) -> &[Symbol]

Returns the codecs this site can decode and encode.

fn answer(&self, cx: &mut Cx, frame: ServerFrame) -> Result<ServerFrame>

Answers frame, returning the reply frame.

fn as_any(&self) -> &dyn Any

Returns the site as &dyn Any for downcasting.

fn answer_with_timeout( &self, cx: &mut Cx, frame: ServerFrame, _timeout: Option<Duration>, ) -> Result<ServerFrame, Error>

Answers frame with an optional deadline. Defaults to EvalSite::answer.

fn close_connection(&self, _cx: &mut Cx) -> Result<(), Error>

Closes any connection backing the site. Defaults to a no-op.

fn stream( &self, cx: &mut Cx, frame: ServerFrame, sink: &mut dyn StreamSink, ) -> Result<(), Error>

Streams the answer to frame into sink. The default path answers once and emits a single chunk followed by end.

fn as_eval_fabric(&self) -> Option<&dyn EvalFabric>

Returns this site as an EvalFabric when it backs one. Defaults to None.

impl Object for Tool

fn display(&self, _cx: &mut Cx) -> Result<String>

Render the object as a human-readable display string.

fn as_any(&self) -> &dyn Any

Expose the object for Rust downcasting.

fn header(&self) -> &ObjectHeader

Identity and trust header for the object; defaults to the shared anonymous header.

fn op(&self, _key: &OpKey) -> Option<&dyn Op>

Resolve the operation registered under key, if any.

fn claims( &self, _cx: &mut Cx, _pattern: &ClaimPattern, _sink: &mut dyn ClaimSink, ) -> Result<(), Error>

Emit the object’s claims matching pattern into sink.

fn snapshot(&self, _cx: &mut Cx) -> Result<Option<Datum>, Error>

Optional content-addressable snapshot of the object’s state.

impl ObjectCompat for Tool

fn class(&self, cx: &mut Cx) -> Result<ClassRef>

Class object this value belongs to; defaults to nil.

fn as_expr(&self, cx: &mut Cx) -> Result<Expr>

Expression form of the object; defaults to an opaque extension node.

fn as_table(&self, cx: &mut Cx) -> Result<Value>

Project the object into a table value; the default exposes its display.

fn as_callable(&self) -> Option<&dyn Callable>

Callable view, if the object can be invoked.

fn as_class(&self) -> Option<&dyn Class>

Class view, if the object is a class.

fn as_shape(&self) -> Option<&dyn Shape>

Shape view, if the object is a shape.

fn as_object_encoder(&self) -> Option<&dyn ObjectEncode>

Object-encoder view, if the object encodes other objects.

fn as_read_constructor(&self) -> Option<&dyn ReadConstructor>

Read-constructor view, if the object decodes data forms.

fn as_number_domain(&self) -> Option<&(dyn NumberDomain + 'static)>

Number-domain view, if the object is a number domain.

fn as_number_value(&self) -> Option<&dyn NumberValue>

Number-value view, if the object is a domain number.

fn as_eval_fabric(&self) -> Option<&dyn EvalFabric>

Eval-fabric view, if the object is a distributed eval surface.

fn as_stream(&self) -> Option<&dyn Stream>

Stream view, if the object is a stream.

fn as_sequence(&self) -> Option<&dyn Sequence>

Sequence view, if the object is a sequence.

fn as_thunk(&self) -> Option<&dyn Thunk>

Thunk view, if the object is a deferred computation.

fn as_list(&self) -> Option<&(dyn ListValue + 'static)>

List view, if the object is a list value.

fn as_table_impl(&self) -> Option<&(dyn Table + 'static)>

Table-implementation view, if the object is a table.

fn as_dir(&self) -> Option<&(dyn Dir + 'static)>

Directory view, if the object is a directory.

fn truth(&self, _cx: &mut Cx) -> Result<bool, Error>

Truthiness of the object; defaults to true.

fn publish_shape_satisfaction_claims( &self, _cx: &mut Cx, _shape: &Ref, ) -> Result<bool, Error>

Publish claims asserting that the object satisfies shape; returns whether any were published.