Struct Workspace 

#[non_exhaustive]
pub struct Workspace {
    pub root: Arc<Path>,
    pub components: Vec<Component>,
    pub modules: Vec<Module>,
    pub environments: Vec<Environment>,
    pub diagnostics: Vec<Diagnostic>,
    pub edges: Vec<Edge>,
}

The fully-parsed workspace, ready for export.

Per 10-data-model.md § 2.1, the workspace owns:

• the set of components (apply-able roots),
• the set of modules referenced from those components,
• the discovered environments, and
• any non-fatal diagnostics produced anywhere in the pipeline.

Construct via [WorkspaceBuilder].

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>

Absolute canonical path of the workspace root.

components: Vec<Component>

Components in path-ascending order (deterministic).

modules: Vec<Module>

Referenced modules (whether the body was walked or not).

environments: Vec<Environment>

Discovered environments.

diagnostics: Vec<Diagnostic>

Workspace-wide non-fatal diagnostics. Per-component diagnostics (e.g. from the Terragrunt resolver) hang off their owning TerragruntConfig.diagnostics instead.

edges: Vec<Edge>

Dependency edges populated by the graph phase (Phase 8 / M5). The list is sorted by (from, to, kind) for deterministic Parquet output (see 15-resource-graph.md § 4).

Implementations

impl Workspace

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

Create a builder for building Workspace. On the builder, call .root(...), .components(...)(optional), .modules(...)(optional), .environments(...)(optional), .diagnostics(...)(optional), .edges(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Workspace.

Trait Implementations

impl Clone for Workspace

fn clone(&self) -> Workspace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workspace

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Workspace

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Workspace

fn eq(&self, other: &Workspace) -> 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 Serialize for Workspace

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Workspace