Struct LocalSandbox 

pub struct LocalSandbox { /* private fields */ }

A Sandbox backed by the local manager.

Implementations

impl LocalSandbox

pub async fn new( binding_name: &str, binding: &LocalSandboxBinding, ) -> Result<Self>

Builds a provider from its binding, reading the route token from the path it names.

The binding carries a path rather than the token itself: a binding is serialized into the workload’s environment, and a secret there is a secret in state.

Trait Implementations

impl Binding for LocalSandbox

impl Debug for LocalSandbox

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

Formats the value using the given formatter.

impl Sandbox for LocalSandbox

fn capabilities(&self) -> SandboxCapabilities

What this platform’s backend supports.

fn create<'life0, 'async_trait>( &'life0 self, request: CreateSessionRequest, ) -> Pin<Box<dyn Future<Output = Result<SandboxSession>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a session that can already take work.

fn get<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<SandboxSession>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetches a session by id, or None if it does not exist.

fn get_or_create<'life0, 'async_trait>( &'life0 self, request: CreateSessionRequest, ) -> Pin<Box<dyn Future<Output = Result<SandboxSession>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetches a session, creating it if absent.

fn list<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<SandboxSession>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Lists sessions belonging to this sandbox’s parent.

fn run_command<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 str, request: RunCommandRequest, ) -> Pin<Box<dyn Future<Output = Result<BoxStream<'static, Result<CommandOutput>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Runs a command, streaming output frames until exactly one terminal frame.

fn read_file<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, session_id: &'life1 str, path: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Reads a file out of the sandbox. Requires files. Paths are normalised and may not escape the root.

fn write_files<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 str, files: BTreeMap<String, Vec<u8>>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Writes files into the sandbox. Requires files.

fn mkdir<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, session_id: &'life1 str, path: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Creates a directory inside the sandbox. Requires files.

fn preview<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 str, port: u16, ) -> Pin<Box<dyn Future<Output = Result<PreviewCapability>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Mints a capability to reach a declared port. Requires preview.

fn suspend<'life0, 'life1, 'async_trait>( &'life0 self, _session_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Suspends a session, preserving state. Requires suspendResume.

fn resume<'life0, 'life1, 'async_trait>( &'life0 self, _session_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Resumes a suspended session. Requires suspendResume.

fn snapshot<'life0, 'life1, 'async_trait>( &'life0 self, _session_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Captures full session state and returns its identifier. Requires snapshot.

fn start_job<'life0, 'life1, 'async_trait>( &'life0 self, _session_id: &'life1 str, _request: RunCommandRequest, ) -> Pin<Box<dyn Future<Output = Result<JobStart>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Starts a command as a job, which outlives the call that started it. Requires jobs.

fn poll_job<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _session_id: &'life1 str, _job_id: &'life2 str, _since_seq: Option<u64>, ) -> Pin<Box<dyn Future<Output = Result<JobPoll>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Reads a job’s output after since_seq, and its ending once it has one. Requires jobs.

fn cancel_job<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _session_id: &'life1 str, _job_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Cancels a job, stopping its command. Requires jobs.

fn terminate<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Terminates a session. Idempotent: terminating an absent session succeeds.

fn as_any(&self) -> &dyn Any

Get a reference to this object as Any for dynamic casting