Struct Sandbox 

pub struct Sandbox { /* private fields */ }

Implementations

impl Sandbox

pub fn sandbox_id(&self) -> &str

pub fn commands(&self) -> &Commands

pub fn files(&self) -> &Files

pub fn client(&self) -> &HeyoClient

pub async fn create( options: SandboxCreateOptions, client_options: HeyoClientOptions, ) -> Result<Self, HeyoError>

Create a new sandbox and (by default) wait for it to leave the provisioning state before returning.

Set options.wait_for_ready = Some(Duration::ZERO) to return immediately and wait_for_ready() later.

pub fn connect( sandbox_id: String, client_options: HeyoClientOptions, ) -> Result<Self, HeyoError>

Reattach to an existing sandbox by ID. Issues no network call.

pub async fn list( client_options: HeyoClientOptions, ) -> Result<Vec<SandboxInfo>, HeyoError>

List all deployed sandboxes the caller can see.

pub async fn list_public_images( backend: Option<&str>, client_options: HeyoClientOptions, ) -> Result<Vec<PublicImage>, HeyoError>

List public images available to deploy.

pub async fn info(&self) -> Result<SandboxInfo, HeyoError>

Fetch the latest info for this sandbox.

pub async fn wait_for_ready( &self, timeout: Duration, ) -> Result<SandboxInfo, HeyoError>

Block until the sandbox transitions out of provisioning.

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

Permanently delete this sandbox. 404 is treated as success.

pub async fn stop(&self) -> Result<(), HeyoError>

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

pub async fn restart(&self) -> Result<(), HeyoError>

pub async fn set_ttl(&self, ttl_seconds: u64) -> Result<(), HeyoError>

Update the sandbox’s TTL (seconds). 0 for unlimited (if plan allows).

pub async fn resize(&self, size: SandboxSize) -> Result<(), HeyoError>

pub async fn checkpoint(&self) -> Result<(), HeyoError>

pub async fn restore(&self) -> Result<(), HeyoError>

pub async fn replace_mount( &self, archive_id: &str, sandbox_path: Option<&str>, ) -> Result<(), HeyoError>

pub async fn get_host(&self, port: u16) -> Result<Option<String>, HeyoError>

Public URL for a port the sandbox has bound, or None if not exposed.

pub async fn shell( &self, options: ShellOptions, ) -> Result<ShellSession, HeyoError>

Open a persistent interactive shell. The returned ShellSession is already past the init/ready handshake.

pub async fn bind_port( &self, port: u16, is_public: Option<bool>, ) -> Result<BoundUrl, HeyoError>

Bind a port and return the resulting public URL.

Trait Implementations

impl Clone for Sandbox

fn clone(&self) -> Sandbox

Returns a duplicate of the value.

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

Performs copy-assignment from source.