Struct CodeMode 

pub struct CodeMode { /* private fields */ }

The code tool of a session: its name, the tools a program can call, its limits and the sandbox it runs in. See the module docs.

Implementations

impl CodeMode

pub fn new() -> Self

A code tool named run_code with no functions yet, the default limits, and the in-process sandbox (or, built without the code-mode feature, a sandbox that refuses every program).

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

Let programs call the tool name.

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

Let programs call the tool name, and declare it only through the code tool, whatever direct says. For a tool whose result the model should never read whole, such as a long history.

pub fn function_returning( self, name: impl Into<String>, returns: impl Into<String>, ) -> Self

Let programs call the tool name, documenting what it returns.

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

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

Let programs call each of names.

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

Name the code tool name instead of run_code.

pub fn limits(self, limits: CodeLimits) -> Self

Bound each program by limits.

pub fn direct(self, direct: bool) -> Self

Whether the functions stay declared as tools of their own (the default). With false the model reaches them only through programs.

pub fn sandbox(self, sandbox: Arc<dyn CodeSandbox>) -> Self

Run programs in sandbox.

pub fn tool(&self) -> &str

The code tool’s name.

pub fn function_list(&self) -> &[CodeFunction]

The functions programs can call.

pub fn limit(&self) -> &CodeLimits

The limits on each program.

pub fn is_direct(&self) -> bool

Whether the functions stay declared as tools of their own.

pub fn sandbox_ref(&self) -> &Arc<dyn CodeSandbox>

The sandbox programs run in.

pub fn exposes(&self, name: &str) -> bool

Whether programs can call the tool name.

pub fn hides(&self, name: &str) -> bool

Whether the model reaches the tool name only through programs.

pub fn declaration<'a>( &self, catalog: impl IntoIterator<Item = &'a FunctionDeclaration>, offered: impl Fn(&str) -> bool, ) -> Option<FunctionDeclaration>

The code tool’s declaration, listing the functions in catalog that programs can call and offered admits. None when there is none, in which case the code tool is not declared either.

pub fn offered_functions<'a>( &self, catalog: impl IntoIterator<Item = &'a FunctionDeclaration>, offered: impl Fn(&str) -> bool, ) -> BTreeSet<String>

The function names of catalog that the code tool’s declaration would list when offered admits them, sorted.

pub fn response(&self, result: Result<Value, String>, printed: &str) -> Value

What the model reads for a program that ended with result and printed printed: {"result": ..} or {"error": ..}, with printed when it printed anything.

impl CodeMode

pub async fn start( &self, program: &str, catalog: &[FunctionDeclaration], ) -> Program

Start program in the sandbox, with the functions this mode exposes defined as globals and named by their declarations in catalog.

The caller drives it: while Program::call names a call, run that call (down the governed path, in a session) and pass its result to Program::answer; then Program::response is what the model reads. Dropping a Program before it finishes cancels it.

Trait Implementations

impl Clone for CodeMode

fn clone(&self) -> CodeMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeMode

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

Formats the value using the given formatter.

impl Default for CodeMode

fn default() -> Self

Returns the “default value” for a type.