Enum TerragruntError 

#[non_exhaustive]
pub enum TerragruntError {
    Cycle(Vec<Arc<Path>>),
    DepthExceeded {
        limit: u32,
    },
    PathEscape {
        path: PathBuf,
    },
    Func {
        func: &'static str,
        message: Box<str>,
        span: Box<Span>,
    },
}

Errors the Terragrunt resolver can surface.

Per 14-terragrunt.md § 6, the variants mirror the spec text. Cycle / path-escape / depth-cap are recorded as crate::Diagnostics on the returned crate::ir::TerragruntConfig in practice — only truly fatal I/O errors (the parent dir disappears mid-walk) bubble up as Err(crate::Error) via the From glue.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Cycle(Vec<Arc<Path>>)

Include cycle detected. The vector captures the canonical stack at the moment the cycle was detected; the offending file is the next path the resolver would have entered.

DepthExceeded

Include stack exceeded the configured depth cap.

Fields

limit: u32

Configured cap.

PathEscape

A path resolved by a Terragrunt function escapes the workspace root.

Fields

path: PathBuf

Path that failed the descendant-of-root check.

Func

A Terragrunt function call failed.

Fields

func: &'static str

Function name.

message: Box<str>

Message safe to log.

span: Box<Span>

Source span.

Trait Implementations

impl Debug for TerragruntError

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

Formats the value using the given formatter.

impl Display for TerragruntError

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

Formats the value using the given formatter.

impl Error for TerragruntError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.