Enum FuncError 

#[non_exhaustive]
pub enum FuncError {
    Arity {
        name: Arc<str>,
        expected: usize,
        got: usize,
    },
    Type {
        name: Arc<str>,
        index: usize,
        expected: &'static str,
        got: &'static str,
    },
    Limit {
        name: Arc<str>,
        kind: LimitKind,
        observed: u64,
        limit: u64,
    },
    PathEscape {
        name: &'static str,
        path: PathBuf,
    },
    Other {
        name: Arc<str>,
        message: Arc<str>,
    },
}

Error returned by an HclFunc::call.

FuncError is the call-site shape; the evaluator converts each variant to an crate::eval::EvalError or a crate::Diagnostic before it surfaces in Workspace.diagnostics. The variants intentionally mirror the evaluator-level types so downstream tooling sees the same LimitKind regardless of whether the breach happened in the walker or inside a function body.

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.

Arity

Wrong number of arguments. expected is usize::MAX for variadic minimum-match failures; messages embed the function-specific shape.

Fields

name: Arc<str>

Function name.

expected: usize

Expected arg count (or usize::MAX for “variadic ≥ N”).

got: usize

Observed arg count.

Type

Argument failed its type check. index is 0-based.

Fields

name: Arc<str>

Function name.

index: usize

Argument index (0-based).

expected: &'static str

Expected type name (e.g. "string", "number").

got: &'static str

Observed type name.

Limit

A function-level limit fired (e.g. result string > max_str_size).

Fields

name: Arc<str>

Function name.

kind: LimitKind

Which limit category fired.

observed: u64

Observed value.

limit: u64

Configured limit.

PathEscape

File function rejected the path because it resolves outside the workspace root.

Fields

name: &'static str

Function name.

path: PathBuf

Path supplied by the caller.

Other

Anything else. The message is rendered verbatim in diagnostics; it should not embed user-controlled data without escaping.

Fields

name: Arc<str>

Function name.

message: Arc<str>

Free-form message; safe to log.

Trait Implementations

impl Clone for FuncError

fn clone(&self) -> FuncError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FuncError

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

Formats the value using the given formatter.

impl Display for FuncError

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

Formats the value using the given formatter.

impl Error for FuncError

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.

impl PartialEq for FuncError

fn eq(&self, other: &FuncError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FuncError

impl StructuralPartialEq for FuncError