Struct Client 

pub struct Client { /* private fields */ }

A configured Sail client. Cheap to clone; shares transport across clones.

Implementations

impl Client

pub fn builder(api_key: impl Into<String>) -> ClientBuilder

Start a ClientBuilder.

pub fn from_env() -> Result<Client, SailError>

Build a client from the environment (SAIL_MODE, SAIL_API_KEY, …).

pub fn from_config(config: Config) -> Result<Client, SailError>

Build a client from an already-resolved Config.

pub fn config(&self) -> &Config

The resolved configuration.

pub async fn create_sailbox( &self, req: &CreateSailboxRequest, create_timeout: Option<Duration>, ) -> Result<SailboxHandle, SailError>

Create a sailbox. create_timeout bounds each attempt of the synchronous create (which the scheduler can block on for minutes); the call still retries, reattaching to the same box, so it returns as soon as the box is ready and gives up after roughly max_attempts * create_timeout. None leaves each attempt unbounded. See SailboxApi::create.

pub async fn get_sailbox( &self, sailbox_id: &str, ) -> Result<SailboxInfo, SailError>

Fetch a single sailbox.

pub async fn list_sailboxes( &self, query: &ListQuery, ) -> Result<SailboxPage, SailError>

List sailboxes in the current org.

pub async fn terminate_sailbox(&self, sailbox_id: &str) -> Result<(), SailError>

Terminate a sailbox (idempotent).

pub async fn pause_sailbox(&self, sailbox_id: &str) -> Result<(), SailError>

Pause a sailbox.

pub async fn sleep_sailbox(&self, sailbox_id: &str) -> Result<(), SailError>

Sleep a sailbox.

pub async fn resume_sailbox( &self, sailbox_id: &str, ) -> Result<SailboxHandle, SailError>

Resume a paused/sleeping sailbox.

pub async fn checkpoint_sailbox( &self, sailbox_id: &str, ) -> Result<SailboxCheckpoint, SailError>

Checkpoint a running sailbox.

pub async fn create_from_checkpoint( &self, checkpoint_id: &str, name: Option<&str>, timeout_seconds: Option<i64>, ) -> Result<SailboxHandle, SailError>

Create a new sailbox from a checkpoint.

pub async fn upgrade_sailbox( &self, sailbox_id: &str, ) -> Result<UpgradeOutcome, SailError>

Upgrade the in-guest agent (applies now if running, else at next wake).

pub async fn expose_listener( &self, sailbox_id: &str, guest_port: u32, protocol: IngressProtocol, allowlist: &[String], ) -> Result<AddListenerResponse, SailError>

Expose a guest port at runtime; returns the add-listener response.

pub async fn unexpose_listener( &self, sailbox_id: &str, guest_port: u32, ) -> Result<(), SailError>

Remove a runtime ingress port.

pub async fn list_listeners( &self, sailbox_id: &str, ) -> Result<Vec<Listener>, SailError>

List a sailbox’s ingress listeners without resuming (waking) the box.

pub async fn get_listener( &self, sailbox_id: &str, guest_port: u32, ) -> Result<Listener, SailError>

Fetch one ingress listener by guest port without resuming (waking) the box; a missing port is a SailError::NotFound.

pub async fn ingress_auth_headers( &self, sailbox_id: &str, ) -> Result<Vec<(String, String)>, SailError>

Ingress-identity headers for this sailbox.

pub async fn org_ssh_ca_public_key(&self) -> Result<String, SailError>

The caller org’s SSH CA public key (created on first use).

pub async fn issue_user_cert( &self, public_key: &str, timeout: Option<f64>, ) -> Result<IssuedUserCert, SailError>

Sign public_key into a short-lived org-CA certificate (principal root). timeout (seconds) bounds a single no-retry attempt; None retries.

pub async fn get_volume( &self, name: &str, mint_if_missing: bool, ) -> Result<NfsVolume, SailError>

Look up (optionally minting) an NFS volume by name.

pub async fn list_volumes( &self, max_objects: Option<i64>, ) -> Result<Vec<NfsVolume>, SailError>

List NFS volumes in the current org.

pub async fn delete_volume( &self, volume_id: &str, allow_missing: bool, ) -> Result<Option<NfsVolume>, SailError>

Delete a volume by id.

pub async fn find_app( &self, name: &str, mint_if_missing: bool, ) -> Result<App, SailError>

Find an app by name on the central API, optionally minting it.

pub async fn list_apps(&self) -> Result<Vec<App>, SailError>

Every app the current org owns, newest first, from the central app index.

pub async fn exec( &self, sailbox_id: &str, argv: Vec<String>, options: ExecOptions, ) -> Result<ExecProcess, SailError>

Run a command in a sailbox and return a handle to the live process.

Resumes (wakes) the sailbox to reach it. The returned ExecProcess streams output, accepts stdin, and resolves the exit status; dropping it detaches without killing the command.

Runtime

Spawns the output pump on the calling task’s tokio runtime (see ExecProcess::start).

pub async fn download_file( &self, sailbox_id: &str, remote_path: &str, ) -> Result<FileReader, SailError>

Open a streaming read of a guest file. Resumes (wakes) the sailbox to reach it; the returned FileReader yields chunks until end of file.

Runtime

Spawns the read pump on the calling task’s tokio runtime (see [crate::worker::WorkerProxy::read_file]).

pub async fn upload_file( &self, sailbox_id: &str, remote_path: &str, options: UploadOptions, ) -> Result<FileWriter, SailError>

Open a streaming write to a guest file. Resumes (wakes) the sailbox to reach it; feed the returned FileWriter with write_chunk and end with finish, so a large source is never buffered whole.

Runtime

Spawns the write RPC on the calling task’s tokio runtime (see [crate::worker::WorkerProxy::write_file]).

impl Client

pub async fn enable_ssh( &self, sailbox_id: &str, wait: bool, timeout: Duration, ) -> Result<Option<SshEndpoint>, SailError>

Make a running sailbox reachable over SSH, returning the endpoint when wait is set (else None). Resumes (wakes) the sailbox to reach it, reserves guest port 22 as TCP ingress if not already exposed, installs the org SSH CA as trusted, (re)starts sshd, and confirms the CA-only daemon is the one serving port 22 (failing rather than leaving a pre-existing daemon in place). Idempotent and safe to re-run.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.