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, timeout: Option<Duration>, ) -> Result<Sailbox, SailError>

Create a sailbox. timeout bounds each attempt of the synchronous create (which the scheduler can block on for minutes); the call retries with one idempotency key so the backend can dedupe rather than duplicate, and gives up after roughly max_attempts * timeout. An interrupted or re-invoked create is a new request and may leave a prior box behind under the same name. 10 minutes is a good default; None leaves each attempt unbounded. If the budget is exhausted the box may still be coming up server-side; find or terminate it by name.

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

List sailboxes in the current org.

pub async fn create_from_checkpoint( &self, checkpoint_id: &str, name: Option<&str>, timeout: Option<Duration>, ) -> Result<Sailbox, SailError>

Create a new sailbox from a checkpoint.

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<Duration>, ) -> 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<VolumeInfo, SailError>

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

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

List NFS volumes in the current org.

pub async fn delete_volume( &self, volume_id: &str, allow_missing: bool, ) -> Result<Option<VolumeInfo>, 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.

impl Client

pub async fn prepare_local_file_upload( &self, content_sha256: &str, content_length: u64, ) -> Result<LocalFileUploadPlan, SailError>

The server’s plan for uploading a content-addressed local file.

pub async fn build_image( &self, spec: &ImageSpec, retry_timeout_secs: f64, ) -> Result<ImageBuild, SailError>

Submit or resume a custom image build. Poll Client::get_image_build_status until the status is ready or failed, or use Client::build_image_definition for the whole pipeline.

pub async fn get_image_build_status( &self, image_id: &str, retry_timeout_secs: f64, ) -> Result<ImageBuild, SailError>

Poll one custom image build’s status.

pub async fn resolve_local_file_step( &self, local_path: &Path, remote_path: &str, mode: Option<u32>, ) -> Result<AddLocalFile, SailError>

Resolve one local file into a content-addressed addLocalFile step, uploading its bytes if the server does not already have them.

pub async fn resolve_local_dir_step( &self, local_path: &Path, remote_path: &str, ignore: &[String], ignore_file: Option<&Path>, ) -> Result<AddLocalDir, SailError>

Resolve one local directory into a content-addressed addLocalDir step: walk it with gitignore-style matching, hash every file, and upload content the server does not already have.

pub async fn resolve_image( &self, def: &ImageDefinition, ) -> Result<ImageSpec, SailError>

Resolve an ImageDefinition into a content-addressed ImageSpec: walk local directories, hash every file, and upload content the server does not already have.

pub async fn build_spec_with_timeout( &self, spec: &ImageSpec, timeout: Duration, ) -> Result<ImageBuild, SailError>

Build an already-resolved spec to ready, bounded by timeout (an unrepresentably large value waits indefinitely). The envelope both bridges and Client::build_image_definition share.

pub async fn build_image_definition( &self, def: &ImageDefinition, timeout: Duration, ) -> Result<ImageSpec, SailError>

Resolve an ImageDefinition and build it to ready, returning the content-addressed ImageSpec to create sailboxes from. A bare builtin base skips the build. timeout bounds the whole pipeline (hashing, uploads, and the build); 30 minutes is a good default, and Duration::MAX waits indefinitely.

pub async fn build_spec_to_ready( &self, spec: &ImageSpec, deadline: Option<Instant>, ) -> Result<ImageBuild, SailError>

Build an already-resolved spec to ready (submit + poll).

impl Client

pub fn sailbox(&self, sailbox_id: impl Into<String>) -> Sailbox

Bind an existing sailbox id to this client without a network call, giving the method-style surface over it.

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.