Struct Config 

pub struct Config {
    pub mode: Option<String>,
    pub api_key: String,
    pub api_url: String,
    pub sailbox_api_url: String,
    pub imagebuilder_url: String,
    pub ingress_base: String,
    pub ingress_scheme: IngressScheme,
}

Resolved SDK configuration: credentials plus the three service endpoints.

Usually produced from the environment and ~/.sail via ClientBuilder or Client::from_env, which also fill the derived fields consistently.

Fields

mode: Option<String>

The environment mode these endpoints were resolved from, or None for the default. Retained so a caller that rebuilds a config from an explicit key can reselect the same environment (including its ingress scheme) rather than fall back to the default.

api_key: String

Bearer API key sent on every request (trimmed of surrounding whitespace).

api_url: String

Base URL of the public Sail REST API (no trailing path).

sailbox_api_url: String

Base URL of the sailbox lifecycle/exec API.

imagebuilder_url: String

host:port endpoint that image builds are submitted to.

ingress_base: String

Base URL that listener URLs are built from when the server does not return one, e.g. https://api.sailresearch.com.

ingress_scheme: IngressScheme

How a listener’s URL is addressed under ingress_base.

Implementations

impl Config

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

Resolve a config from the environment, falling back to the stored ~/.sail credential and settings for any value the environment does not set. Environment variables always win. The stored API key is applied only when its tagged target matches the resolved one, so a key minted for one environment is never sent to another. The key is trimmed so one sourced with a trailing newline can’t produce a malformed bearer token.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.