Struct PlanCommand 

pub struct PlanCommand { /* private fields */ }

Command for creating a Terraform execution plan.

Terraform plan uses exit code 2 to indicate “changes present” which is treated as a success by this wrapper (not an error).

use terraform_wrapper::{Terraform, TerraformCommand};
use terraform_wrapper::commands::plan::PlanCommand;

let tf = Terraform::builder().working_dir("/tmp/infra").build()?;
let output = PlanCommand::new()
    .var("region", "us-west-2")
    .out("tfplan")
    .execute(&tf)
    .await?;

Implementations

impl PlanCommand

pub fn new() -> Self

Create a new plan command with default options.

pub fn var(self, name: &str, value: &str) -> Self

Set a variable value (-var="name=value").

pub fn var_file(self, path: &str) -> Self

Add a variable definitions file (-var-file).

pub fn out(self, path: &str) -> Self

Save the plan to a file (-out).

pub fn target(self, resource: &str) -> Self

Target a specific resource or module (-target).

pub fn replace(self, resource: &str) -> Self

Mark a resource for replacement (-replace).

pub fn destroy(self) -> Self

Create a destroy plan (-destroy).

pub fn refresh_only(self) -> Self

Create a plan that only refreshes state (-refresh-only).

pub fn refresh(self, enabled: bool) -> Self

Enable or disable refreshing state (-refresh).

Pass false to skip checking for external changes during planning.

pub fn compact_warnings(self) -> Self

Show warnings in compact form (-compact-warnings).

pub fn lock(self, enabled: bool) -> Self

Enable or disable state locking (-lock).

pub fn lock_timeout(self, timeout: &str) -> Self

Duration to wait for state lock (-lock-timeout).

pub fn parallelism(self, n: u32) -> Self

Limit the number of concurrent operations (-parallelism).

pub fn detailed_exitcode(self) -> Self

Return a detailed exit code (-detailed-exitcode).

When enabled, exit code 0 means no changes, exit code 2 means changes are present. Without this flag, exit code 0 means success regardless of whether changes are needed.

pub fn json(self) -> Self

Enable machine-readable JSON output (-json).

When enabled, stdout contains streaming JSON log lines (one per event), not a single JSON blob.

pub fn arg(self, arg: impl Into<String>) -> Self

Add a raw argument (escape hatch for unsupported options).

Trait Implementations

impl Clone for PlanCommand

fn clone(&self) -> PlanCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlanCommand

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

Formats the value using the given formatter.

impl Default for PlanCommand

fn default() -> PlanCommand

Returns the “default value” for a type.

impl TerraformCommand for PlanCommand

type Output = CommandOutput

The output type produced by this command.

fn args(&self) -> Vec<String>

Build the argument list for this command.

fn supports_input(&self) -> bool

Whether this command supports the -input=false flag.

async fn execute(&self, tf: &Terraform) -> Result<CommandOutput>

Execute this command against the given Terraform client.

fn prepare_args(&self, tf: &Terraform) -> Vec<String>

Build the argument list with -input=false injected when appropriate.