pub struct MontyPythonCodeToolBuilder { /* private fields */ }tools only.Expand description
Configures a MontyPythonCodeTool: OS-access grants, host
functions, and limits are forwarded to MontyExecutorBuilder; the
terminal methods select the mode.
§Example
use adk_code::PathAccess;
use adk_tool::{MontyPythonCodeTool, Tool};
let tool = MontyPythonCodeTool::builder()
.environ_var("PROJECT", "acme")
.system_clock()
.build_repl()?;
assert!(tool.description().contains("PROJECT"));Implementations§
Source§impl MontyPythonCodeToolBuilder
impl MontyPythonCodeToolBuilder
Sourcepub fn new() -> MontyPythonCodeToolBuilder
Available on crate feature code only.
pub fn new() -> MontyPythonCodeToolBuilder
code only.Start with the fully sandboxed defaults.
Sourcepub fn allow_path(
self,
virtual_path: impl Into<String>,
host_path: impl Into<PathBuf>,
access: PathAccess,
) -> MontyPythonCodeToolBuilder
Available on crate feature code only.
pub fn allow_path( self, virtual_path: impl Into<String>, host_path: impl Into<PathBuf>, access: PathAccess, ) -> MontyPythonCodeToolBuilder
code only.Make a host directory available to scripts at virtual_path.
See MontyExecutorBuilder::allow_path.
Sourcepub fn environ<K, V>(
self,
vars: impl IntoIterator<Item = (K, V)>,
) -> MontyPythonCodeToolBuilder
Available on crate feature code only.
pub fn environ<K, V>( self, vars: impl IntoIterator<Item = (K, V)>, ) -> MontyPythonCodeToolBuilder
code only.Replace the environment map exposed via os.getenv / os.environ.
See MontyExecutorBuilder::environ.
Sourcepub fn environ_var(
self,
key: impl Into<String>,
value: impl Into<String>,
) -> MontyPythonCodeToolBuilder
Available on crate feature code only.
pub fn environ_var( self, key: impl Into<String>, value: impl Into<String>, ) -> MontyPythonCodeToolBuilder
code only.Add or overwrite a single environment variable.
See MontyExecutorBuilder::environ_var.
Sourcepub fn system_clock(self) -> MontyPythonCodeToolBuilder
Available on crate feature code only.
pub fn system_clock(self) -> MontyPythonCodeToolBuilder
code only.Grant host-clock access (date.today() / datetime.now()).
See MontyExecutorBuilder::system_clock.
Sourcepub fn function(
self,
function: Arc<dyn HostFunction>,
) -> MontyPythonCodeToolBuilder
Available on crate feature code only.
pub fn function( self, function: Arc<dyn HostFunction>, ) -> MontyPythonCodeToolBuilder
code only.Register a host function callable from Python by bare name.
See MontyExecutorBuilder::function.
Sourcepub fn function_fn<F, Fut>(
self,
name: impl Into<String>,
description: impl Into<String>,
func: F,
) -> MontyPythonCodeToolBuilder
Available on crate feature code only.
pub fn function_fn<F, Fut>( self, name: impl Into<String>, description: impl Into<String>, func: F, ) -> MontyPythonCodeToolBuilder
code only.Register a closure as a host function.
See MontyExecutorBuilder::function_fn.
Sourcepub fn max_memory(self, bytes: usize) -> MontyPythonCodeToolBuilder
Available on crate feature code only.
pub fn max_memory(self, bytes: usize) -> MontyPythonCodeToolBuilder
code only.Cap the interpreter’s memory use in bytes.
See MontyExecutorBuilder::max_memory.
Sourcepub fn host_function_timeout(
self,
timeout: Duration,
) -> MontyPythonCodeToolBuilder
Available on crate feature code only.
pub fn host_function_timeout( self, timeout: Duration, ) -> MontyPythonCodeToolBuilder
code only.Wall-clock bound for a single host-function call.
See MontyExecutorBuilder::host_function_timeout.
Sourcepub fn max_sessions(self, max_sessions: usize) -> MontyPythonCodeToolBuilder
Available on crate feature code only.
pub fn max_sessions(self, max_sessions: usize) -> MontyPythonCodeToolBuilder
code only.Cap on concurrently retained REPL sessions (default 100). The least recently used session is evicted at the cap; its next call starts a fresh interpreter. A value of 0 is treated as 1.
Sourcepub fn build_one_shot(self) -> Result<MontyPythonCodeTool, MontyBuildError>
Available on crate feature code only.
pub fn build_one_shot(self) -> Result<MontyPythonCodeTool, MontyBuildError>
code only.Build a one-shot tool: each call runs in a fresh interpreter.
§Errors
Returns a MontyBuildError when the host-function registry is
invalid.
Sourcepub fn build_repl(self) -> Result<MontyPythonCodeTool, MontyBuildError>
Available on crate feature code only.
pub fn build_repl(self) -> Result<MontyPythonCodeTool, MontyBuildError>
code only.Build a REPL tool: interpreter state persists across calls, scoped per ADK session.
§Errors
Returns a MontyBuildError when the host-function registry is
invalid.
Trait Implementations§
Source§impl Default for MontyPythonCodeToolBuilder
impl Default for MontyPythonCodeToolBuilder
Source§fn default() -> MontyPythonCodeToolBuilder
fn default() -> MontyPythonCodeToolBuilder
Auto Trait Implementations§
impl !RefUnwindSafe for MontyPythonCodeToolBuilder
impl !UnwindSafe for MontyPythonCodeToolBuilder
impl Freeze for MontyPythonCodeToolBuilder
impl Send for MontyPythonCodeToolBuilder
impl Sync for MontyPythonCodeToolBuilder
impl Unpin for MontyPythonCodeToolBuilder
impl UnsafeUnpin for MontyPythonCodeToolBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreimpl<T> MaybeSend for Twhere
T: Send,
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.