Skip to main content

Sandbox

Struct Sandbox 

Source
pub struct Sandbox { /* private fields */ }
Expand description

A live sandbox handle. Exposes the core namespaces.

Implementations§

Source§

impl Sandbox

Source

pub fn id(&self) -> &str

The session id.

Source

pub fn kind(&self) -> &str

The VM flavour — "sandbox" or "desktop".

Source

pub fn control_url(&self) -> &str

The control-WS URL.

Source

pub fn stream_url(&self) -> Option<&str>

The live-view stream URL. Some for desktops only — a headless sandbox has no display, so the gateway omits it.

Source

pub fn recording_url(&self) -> Option<&str>

The session recording link, when the create asked for a recording.

Source

pub fn expires_at(&self) -> &str

ISO-8601 expiry timestamp.

Source

pub fn connected(&self) -> bool

Whether the control channel is open.

Source

pub async fn connect(&self) -> Result<(), SolariError>

Open the control WebSocket. Idempotent.

Source

pub fn close(&self)

Close the control channel locally (does NOT release the remote session).

Source

pub async fn pause(&self) -> Result<(), SolariError>

Pause this session: snapshot its RAM+disk, free its host slot, and close the control channel. The session keeps its id; bring it back with Sandbox::resume.

Mirrors TS handle.pause() / Python handle.pause(): remote call first, then the local channel close.

Source

pub async fn resume(&mut self) -> Result<(), SolariError>

Resume this paused session and re-point the control channel at the fresh slot it came back on.

Mirrors TS handle.resume() / Python handle.resume(): resume, adopt the new control URL, reconnect.

Takes &mut self where the rest of the handle takes &self: resuming genuinely replaces this handle’s control_url, and Sandbox::control_url hands out a borrow of it. Interior mutability would let that borrow go stale behind the caller’s back — the compiler should be the one saying this call mutates the handle.

Source

pub async fn start(&mut self) -> Result<(), SolariError>

Cold-boot this STOPPED session from its kept disk and re-point the control channel at the fresh control URL. Processes and memory are gone, files on disk are kept. See Client::start for the refusal codes.

Takes &mut self for the same reason as Sandbox::resume: it replaces this handle’s control_url.

Source

pub async fn kill(&self) -> Result<(), SolariError>

Destroy the remote session and close the channel. Idempotent.

Source

pub fn commands(&self) -> Commands<'_>

Source

pub fn files(&self) -> Files<'_>

Source

pub fn code(&self) -> Code<'_>

Source

pub fn git(&self) -> Git<'_>

Trait Implementations§

Source§

impl GitRunner for Sandbox

Sandbox runs git through commands.run("git", …) (no shell).

Source§

fn run_git<'a>( &'a self, args: Vec<String>, cwd: Option<String>, ) -> Pin<Box<dyn Future<Output = Result<CommandResult, SolariError>> + Send + 'a>>

Source§

fn run_git_env<'a>( &'a self, args: Vec<String>, cwd: Option<String>, env: Option<HashMap<String, String>>, ) -> Pin<Box<dyn Future<Output = Result<CommandResult, SolariError>> + Send + 'a>>

Like run_git with environment variables for the command (used to hand credentials to git). The default refuses rather than dropping them: a runner that cannot pass an environment must not run an authenticated command as an unauthenticated one.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more