Skip to main content

EvalContext

Struct EvalContext 

Source
#[non_exhaustive]
pub struct EvalContext { pub workspace_root: Arc<Path>, pub environment: Option<Arc<str>>, pub env_vars: EnvVarMode, pub repo_vars: Map, pub cascade_locals: Map, pub funcs: Arc<FuncRegistry>, pub limits: EvalLimits, }
Expand description

Read-only inputs to a single crate::eval::Evaluator::evaluate call.

repo_vars and cascade_locals are insertion-ordered Maps (see 10-data-model.md § 2.3) — order preservation matters for the canonical JSON in error diagnostics. funcs is an Arc<FuncRegistry> so the same table is shared across all components in a workspace without cloning.

Fields (Non-exhaustive)§

This struct is marked as 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>

Absolute, canonicalised workspace root. All sandboxed file functions validate paths against this root.

§environment: Option<Arc<str>>

Optional environment name (e.g. Some("staging")). Bound as the terraform.workspace placeholder for the evaluator pass; downstream resource rows surface it in the environment column.

§env_vars: EnvVarMode

How get_env(...) reads the process environment.

§repo_vars: Map

var.* bindings from .tfvars and CLI --var k=v flags.

§cascade_locals: Map

local.* shadows injected from a Terragrunt cascade (Phase 6 will populate this; Phase 4 accepts an empty map and a synthetic one for tests).

§funcs: Arc<FuncRegistry>

Registered functions (stdlib + Terraform-only + sandboxed file + Terragrunt helpers).

§limits: EvalLimits

Per-call resource limits.

Implementations§

Source§

impl EvalContext

Source

pub fn new( workspace_root: Arc<Path>, environment: Option<Arc<str>>, env_vars: EnvVarMode, repo_vars: Map, cascade_locals: Map, funcs: Arc<FuncRegistry>, limits: EvalLimits, ) -> Self

Construct a fully-specified EvalContext. Public because downstream crates (the CLI, the future server) build contexts from their own config sources; the struct is #[non_exhaustive] so the constructor is the stable surface even when fields evolve.

Source

pub fn minimal(workspace_root: Arc<Path>) -> Result<Self, ValidationError>

Construct a minimal context pinned to workspace_root with default limits, empty repo_vars / cascade_locals, an empty registry, and strict env-var mode (empty allowlist). Convenience for tests and the default CLI invocation.

§Errors

Returns ValidationError::Empty when workspace_root is an empty path — the evaluator requires a non-empty root for the sandboxed path helpers to reject escapes meaningfully.

Source

pub fn lookup_repo_var(&self, name: &str) -> Option<&Value>

Read a binding for name from repo_vars.

Source

pub fn lookup_cascade_local(&self, name: &str) -> Option<&Value>

Read a binding for name from cascade_locals.

Trait Implementations§

Source§

impl Clone for EvalContext

Source§

fn clone(&self) -> EvalContext

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EvalContext

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more