Struct PipelineOptions 

#[non_exhaustive]
pub struct PipelineOptions {
    pub root: Arc<Path>,
    pub environment: Option<Arc<str>>,
    pub env_var_mode: EnvVarMode,
    pub allowed_env: BTreeSet<Arc<str>>,
    pub repo_vars: Map,
    pub max_walk_depth: u32,
    pub max_total_files: u64,
    pub max_file_bytes: u64,
    pub max_include_depth: u32,
    pub follow_symlinks: bool,
}

Options for Pipeline::run.

Build via [PipelineOptionsBuilder]; defaults are conservative (resource limits at spec defaults, env mode strict-with-empty-allowlist).

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.

root: Arc<Path>

Workspace root passed by the caller.

environment: Option<Arc<str>>

Optional environment name to pin (var.environment).

env_var_mode: EnvVarMode

How the evaluator treats get_env(...).

allowed_env: BTreeSet<Arc<str>>

Allowlist of TF_VAR_* / generic env vars visible to get_env / Terragrunt funcs. Defaults to empty.

repo_vars: Map

Repo-level var.* bindings (CLI --var k=v / .tfvars). Stored as a sorted vec for stable iteration; see crate::ir::Map.

max_walk_depth: u32

Maximum walk depth (discovery). Default: 16.

max_total_files: u64

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

max_file_bytes: u64

Maximum size per file. Default: 4 MiB.

max_include_depth: u32

Maximum Terragrunt include depth. Default: 32.

follow_symlinks: bool

Whether the discoverer follows symlinks. Default: false.

Implementations

impl PipelineOptions

pub fn builder() -> PipelineOptionsBuilder<((), (), (), (), (), (), (), (), (), ())>

Create a builder for building PipelineOptions. On the builder, call .root(...), .environment(...)(optional), .env_var_mode(...)(optional), .allowed_env(...)(optional), .repo_vars(...)(optional), .max_walk_depth(...)(optional), .max_total_files(...)(optional), .max_file_bytes(...)(optional), .max_include_depth(...)(optional), .follow_symlinks(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of PipelineOptions.

impl PipelineOptions

pub fn new(root: impl Into<Arc<Path>>) -> Self

Convenience constructor pinning the workspace root with all other fields at spec defaults.

Trait Implementations

impl Clone for PipelineOptions

fn clone(&self) -> PipelineOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PipelineOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PipelineOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PipelineOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.