pub struct Sandbox { /* private fields */ }Expand description
Approval-owning boundary around one execution backend.
Implementations§
Source§impl Sandbox
impl Sandbox
Sourcepub fn new(backend: Arc<dyn SandboxBackend>, policy: ApprovalPolicy) -> Self
pub fn new(backend: Arc<dyn SandboxBackend>, policy: ApprovalPolicy) -> Self
Creates a sandbox with its initial approval policy.
Sourcepub fn approval_reviewer(self, reviewer: ApprovalReviewerConfig) -> Self
pub fn approval_reviewer(self, reviewer: ApprovalReviewerConfig) -> Self
Configures the isolated model reviewer used by automatic approval.
Sourcepub fn read_bytes<'a>(
&'a self,
path: &'a str,
max_bytes: usize,
) -> BoxFuture<'a, Result<Vec<u8>>>
pub fn read_bytes<'a>( &'a self, path: &'a str, max_bytes: usize, ) -> BoxFuture<'a, Result<Vec<u8>>>
Reads one bounded binary file.
Sourcepub fn write<'a>(
&'a self,
path: &'a str,
content: &'a str,
permissions: &'a ToolPermissions,
) -> BoxFuture<'a, Result<()>>
pub fn write<'a>( &'a self, path: &'a str, content: &'a str, permissions: &'a ToolPermissions, ) -> BoxFuture<'a, Result<()>>
Writes a UTF-8 file when this call has mutation authority.
Sourcepub fn execute<'a>(
&'a self,
command: &'a str,
permissions: &'a ToolPermissions,
) -> BoxFuture<'a, Result<CommandOutput>>
pub fn execute<'a>( &'a self, command: &'a str, permissions: &'a ToolPermissions, ) -> BoxFuture<'a, Result<CommandOutput>>
Runs a command when this call has mutation authority.
Trait Implementations§
Source§impl Middleware for Sandbox
impl Middleware for Sandbox
Source§fn frontend(&self) -> FrontendContribution
fn frontend(&self) -> FrontendContribution
Declares commands and status data that any frontend may render.
Source§fn prompt_section(
&self,
_runtime: &RuntimeContext,
) -> Result<Option<PromptSection>>
fn prompt_section( &self, _runtime: &RuntimeContext, ) -> Result<Option<PromptSection>>
Contributes one immutable system-prompt section while the agent is created.
Source§fn render(&self, event: &EventMsg, _session_id: &str) -> Option<FrontendBlock>
fn render(&self, event: &EventMsg, _session_id: &str) -> Option<FrontendBlock>
Renders an event owned by this capability for the destination session. Read more
Source§fn session_start<'a>(
&'a self,
context: &'a mut SessionStartContext<'_>,
) -> BoxFuture<'a, Result<()>>
fn session_start<'a>( &'a self, context: &'a mut SessionStartContext<'_>, ) -> BoxFuture<'a, Result<()>>
Starts or re-enters a session lifecycle.
Source§fn session_end<'a>(
&'a self,
runtime: &'a RuntimeContext,
) -> BoxFuture<'a, Result<()>>
fn session_end<'a>( &'a self, runtime: &'a RuntimeContext, ) -> BoxFuture<'a, Result<()>>
Releases session-local state when the agent runtime stops.
Source§fn register(
&self,
_catalog: &mut Catalog,
_runtime: &RuntimeContext,
) -> Result<()>
fn register( &self, _catalog: &mut Catalog, _runtime: &RuntimeContext, ) -> Result<()>
Adds tools to the catalog while the agent is created.
Source§fn command<'a>(
&'a self,
context: MiddlewareCommandContext<'a>,
) -> BoxFuture<'a, Result<MiddlewareCommandOutput>>
fn command<'a>( &'a self, context: MiddlewareCommandContext<'a>, ) -> BoxFuture<'a, Result<MiddlewareCommandOutput>>
Handles a command declared by this middleware’s frontend contribution.
Source§fn user_prompt_submit<'a>(
&'a self,
_context: &'a mut UserPromptSubmitContext<'_>,
) -> BoxFuture<'a, Result<()>>
fn user_prompt_submit<'a>( &'a self, _context: &'a mut UserPromptSubmitContext<'_>, ) -> BoxFuture<'a, Result<()>>
Intercepts a user prompt before it enters durable context.
Source§fn active_operations(&self) -> &'static [&'static str]
fn active_operations(&self) -> &'static [&'static str]
Declares active-turn operations owned by this middleware.
Source§fn active_submission(
&self,
_context: &mut ActiveSubmissionContext<'_>,
) -> Result<ActiveSubmissionResult>
fn active_submission( &self, _context: &mut ActiveSubmissionContext<'_>, ) -> Result<ActiveSubmissionResult>
Handles one declared active-turn operation.
Source§fn active_command<'a>(
&'a self,
_context: &'a mut ActiveCommandContext<'_>,
) -> BoxFuture<'a, Result<Option<ActiveSubmissionResult>>>
fn active_command<'a>( &'a self, _context: &'a mut ActiveCommandContext<'_>, ) -> BoxFuture<'a, Result<Option<ActiveSubmissionResult>>>
Handles a capability command while a turn is active. Read more
Source§fn pre_model<'a>(
&'a self,
_context: &'a mut ModelContext<'_>,
) -> BoxFuture<'a, Result<()>>
fn pre_model<'a>( &'a self, _context: &'a mut ModelContext<'_>, ) -> BoxFuture<'a, Result<()>>
Mutates durable context before the next model request is assembled.
Source§fn model_request<'a>(
&'a self,
_context: &'a mut ModelRequestContext<'_>,
) -> BoxFuture<'a, Result<()>>
fn model_request<'a>( &'a self, _context: &'a mut ModelRequestContext<'_>, ) -> BoxFuture<'a, Result<()>>
Applies request-only context after every durable transform has completed.
Source§fn pre_tool_use<'a>(
&'a self,
_context: &'a mut PreToolUseContext<'_>,
) -> BoxFuture<'a, Result<()>>
fn pre_tool_use<'a>( &'a self, _context: &'a mut PreToolUseContext<'_>, ) -> BoxFuture<'a, Result<()>>
Intercepts one normalized tool call before authorization and persistence.
Source§fn permission_request<'a>(
&'a self,
_context: &'a mut PermissionRequestContext<'_>,
) -> BoxFuture<'a, Result<()>>
fn permission_request<'a>( &'a self, _context: &'a mut PermissionRequestContext<'_>, ) -> BoxFuture<'a, Result<()>>
Decides whether an approval request should be deferred, allowed, or denied.
Source§fn post_tool_use<'a>(
&'a self,
_context: &'a mut PostToolUseContext<'_>,
) -> BoxFuture<'a, Result<()>>
fn post_tool_use<'a>( &'a self, _context: &'a mut PostToolUseContext<'_>, ) -> BoxFuture<'a, Result<()>>
Transforms model-visible feedback after a tool has executed.
Source§fn pre_compact<'a>(
&'a self,
_context: &'a mut CompactContext<'_>,
) -> BoxFuture<'a, Result<()>>
fn pre_compact<'a>( &'a self, _context: &'a mut CompactContext<'_>, ) -> BoxFuture<'a, Result<()>>
Intercepts context immediately before compaction and may stop the active turn.
Source§fn post_compact<'a>(
&'a self,
_context: &'a mut CompactContext<'_>,
) -> BoxFuture<'a, Result<()>>
fn post_compact<'a>( &'a self, _context: &'a mut CompactContext<'_>, ) -> BoxFuture<'a, Result<()>>
Intercepts the committed compacted context and may stop the active turn.
Auto Trait Implementations§
impl !Freeze for Sandbox
impl !RefUnwindSafe for Sandbox
impl !UnwindSafe for Sandbox
impl Send for Sandbox
impl Sync for Sandbox
impl Unpin for Sandbox
impl UnsafeUnpin for Sandbox
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
Mutably borrows from an owned value. Read more