Struct Component 

#[non_exhaustive]
pub struct Component {
    pub id: ComponentId,
    pub path: Arc<Path>,
    pub kind: ComponentKind,
    pub files: Vec<SourceFile>,
    pub variables: Vec<Variable>,
    pub locals: Vec<Local>,
    pub providers: Vec<ProviderBlock>,
    pub resources: Vec<Resource>,
    pub modules: Vec<ModuleCall>,
    pub outputs: Vec<Output>,
    pub terragrunt: Option<TerragruntConfig>,
    pub state_backend: Option<StateBackend>,
}

An apply-able component (Terraform “root module”).

Field order matches 10-data-model.md § 2.1. Build via [ComponentBuilder].

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.

id: ComponentId

Stable-within-a-run id.

path: Arc<Path>

Path of the component dir, relative to crate::ir::Workspace::root.

kind: ComponentKind

Whether this is an apply-able root or a reusable module body.

files: Vec<SourceFile>

Source files belonging to this component (*.tf, *.tfvars, terragrunt.hcl, …).

variables: Vec<Variable>

variable "..." {} blocks declared in the component.

locals: Vec<Local>

locals { ... } entries (flattened across multiple locals blocks).

providers: Vec<ProviderBlock>

provider "..." {} declarations.

resources: Vec<Resource>

resource and data blocks, post-evaluation. Module-expanded resources from child modules are appended here at the graph phase.

modules: Vec<ModuleCall>

module "name" { ... } call sites. Per 10-data-model.md § 2.1, the field is named modules even though Workspace::modules also exists — they are different types (ModuleCall here vs Module there) and the local name matches the HCL keyword.

outputs: Vec<Output>

output "..." {} blocks.

terragrunt: Option<TerragruntConfig>

Terragrunt-driven configuration, if any.

state_backend: Option<StateBackend>

Resolved state backend from terraform { backend ... } or generate "backend".

Implementations

impl Component

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

Create a builder for building Component. On the builder, call .id(...), .path(...), .kind(...), .files(...)(optional), .variables(...)(optional), .locals(...)(optional), .providers(...)(optional), .resources(...)(optional), .modules(...)(optional), .outputs(...)(optional), .terragrunt(...)(optional), .state_backend(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Component.

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Component

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Component

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Component

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

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 Component