Struct ParserBuilder 

#[non_exhaustive]
pub struct ParserBuilder { /* private fields */ }

Builder for Parser. Every method consumes and returns self so configuration reads top-to-bottom.

Implementations

impl ParserBuilder

pub fn workspace_root(self, root: impl AsRef<Path>) -> Self

Required. Workspace root (the directory that contains the Terraform / Terragrunt code).

pub fn environment(self, name: impl Into<Arc<str>>) -> Self

Pin terraform.workspace / Terragrunt cascade choice. Optional; when unset the resolver leaves var.environment unresolved.

pub fn env_var_mode(self, mode: EnvVarMode) -> Self

How get_env(...) / Terragrunt funcs read the process env. Default: strict with an empty allowlist (no env vars are visible to user code).

pub fn allow_env(self, name: impl Into<Arc<str>>) -> Self

Allow a single env var name through get_env(...). Repeatable.

pub fn allow_env_many<I, S>(self, names: I) -> Self

where I: IntoIterator<Item = S>, S: Into<Arc<str>>,

Allowlist multiple env var names in one call.

pub fn var(self, key: impl Into<Arc<str>>, value: impl Into<Arc<str>>) -> Self

Repo-level var.<key> = value binding. Repeatable. Values are stored as Value::Str; for richer types build the Map manually via Self::repo_vars.

pub fn repo_vars(self, vars: Map) -> Self

Replace the repo-level variable map. See also Self::var.

pub fn profile_map(self, map: Arc<ProfileMap>) -> Self

Pin an explicit ProfileMap for the provider resolver.

pub fn load_profile_map_yaml(self, path: impl AsRef<Path>) -> Result<Self>

Load the profile map from a YAML file (spec 16 § 3.2).

Errors

Returns Error::Provider when the file is missing, malformed, or violates the validator rules (account-id pattern, region length, etc.).

pub fn load_aws_config(self, path: impl AsRef<Path>) -> Result<Self>

Load the profile map from an ~/.aws/config-shaped INI file (spec 16 § 3.1).

Errors

Returns Error::Provider when the file is missing or malformed.

pub fn default_region(self, region: impl AsRef<str>) -> Result<Self>

Default AWS region applied when neither provider blocks nor the Terragrunt cascade supply one.

Errors

Returns Error::Validation when region fails the Region validator (charset / length).

pub const fn strict_providers(self, strict: bool) -> Self

If true, the provider resolver returns StrictUnresolved when a referenced profile is missing from the profile map. Default: false.

pub const fn max_walk_depth(self, depth: u32) -> Self

Maximum walk depth (discovery). Default: 16.

pub const fn max_total_files(self, n: u64) -> Self

Maximum total files in the workspace. Default: 200 000.

pub const fn max_file_bytes(self, n: u64) -> Self

Maximum size per file. Default: 4 MiB.

pub const fn max_include_depth(self, n: u32) -> Self

Maximum Terragrunt include depth. Default: 32.

pub const fn follow_symlinks(self, follow: bool) -> Self

Whether the discoverer follows symlinks. Default: false.

pub fn build(self) -> Result<Parser>

Finalise into a Parser.

Errors

Returns Error::Validation when workspace_root was not set.

Trait Implementations

impl Clone for ParserBuilder

fn clone(&self) -> ParserBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParserBuilder

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

Formats the value using the given formatter.

impl Default for ParserBuilder

fn default() -> ParserBuilder

Returns the “default value” for a type.