Struct Settings 

pub struct Settings {
    pub directory: PathBuf,
    pub profile_name: Option<String>,
    pub docker_image: String,
    pub profile_config: ProfileConfig,
    pub dependencies: BTreeSet<ObjectId>,
    /* private fields */
}

Resolved settings for an mz-deploy execution.

Constructed once in main.rs from CLI args + project.toml + profiles.toml, then passed to every command. Commands extract what they need (directory, profile_name, profile_suffix, docker_image, connection(), profile_config, dependencies).

profile_name is None for commands that don’t require a connection (compile, test, explain) when no profile is set. In that mode profile_config is the default (no variables, no suffix), and any SQL referencing an unresolved variable will fail with a hint to set a profile.

Fields

directory: PathBuf

Project root directory (from –directory, default “.”).

profile_name: Option<String>

Resolved profile name (CLI –profile overrides project.toml default). None when no profile is configured and the command doesn’t require one.

docker_image: String

Resolved Docker image for type checking and tests.

profile_config: ProfileConfig

Per-profile config (security, profile_suffix) — used for SecretResolver. Default-constructed (empty variables, no suffix) when profile_name is None.

dependencies: BTreeSet<ObjectId>

Validated external dependencies declared in project.toml.

Implementations

impl Settings

pub fn load( directory: PathBuf, cli_profile: Option<&str>, docker_image_override: Option<&str>, needs_connection: bool, profiles_dir: Option<&Path>, ) -> Result<Self, ConfigError>

Load settings from CLI args, project.toml, and profiles.toml.

needs_connection controls whether a connection profile is loaded from profiles.toml. Commands like compile and test don’t need one and will succeed with no profile selected; in that case profile_name is None and profile_config is default.

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

The active profile name, if one is set.

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

Profile suffix applied to both database and cluster names (e.g., "_staging").

pub fn variables(&self) -> &BTreeMap<String, String>

psql-style variables for this profile.

pub fn emulator(&self) -> bool

Whether this profile targets the single-user emulator, in which case the RBAC role/grant machinery is treated as disabled.

pub fn connection(&self) -> &Profile

Returns the database connection profile.

Panics

Panics if Settings was loaded with needs_connection: false. Calling this on a non-connected Settings is a programmer error.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.