Struct TgContext 

#[non_exhaustive]
pub struct TgContext {
    pub workspace_root: Arc<Path>,
    pub environment: Option<Arc<str>>,
    pub env_var_mode: EnvVarMode,
    pub allowed_env: Arc<BTreeSet<Arc<str>>>,
    pub max_include_depth: u32,
}

Read-only inputs to a single crate::terragrunt::TerragruntResolver::resolve call.

allowed_env is wrapped in Arc<BTreeSet<Arc<str>>> per [14-terragrunt.md § 9 CLAUDE.md anchoring] so it’s cheap to share across rayon worker threads. max_include_depth defaults to 32, matching the spec’s pin.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

workspace_root: Arc<Path>

Canonical absolute workspace root. Every Terragrunt-function-resolved path must remain underneath this; the resolver enforces it via the internal canonicalize_inside helper.

environment: Option<Arc<str>>

Pinned environment name (e.g. Some("staging")). Surfaces as terraform.workspace in downstream evaluator scopes; the resolver itself does not consult it for get_env.

env_var_mode: EnvVarMode

How get_env(name, default?) reads the process environment. Default is EnvVarMode::Strict with an empty allowlist (off by default).

allowed_env: Arc<BTreeSet<Arc<str>>>

Allowlist of environment-variable names visible to get_env. Same shape as crate::eval::EvalContext’s field; kept separate to allow tighter Terragrunt-only policy.

max_include_depth: u32

Maximum include-chain depth before crate::terragrunt::TerragruntError::DepthExceeded fires. Default: 32.

Implementations

impl TgContext

pub fn new(workspace_root: Arc<Path>) -> Self

Construct a TgContext with the spec defaults: env-var mode strict with empty allowlist, max_include_depth = 32.

Trait Implementations

impl Clone for TgContext

fn clone(&self) -> TgContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TgContext

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

Formats the value using the given formatter.