Trait TerraformCommand 

pub trait TerraformCommand: Send + Sync {
    type Output: Send;

    // Required methods
    fn args(&self) -> Vec<String>;
    fn execute(
        &self,
        tf: &Terraform,
    ) -> impl Future<Output = Result<Self::Output>> + Send;

    // Provided methods
    fn supports_input(&self) -> bool { ... }
    fn prepare_args(&self, tf: &Terraform) -> Vec<String> { ... }
}

Trait implemented by all Terraform command builders.

Each command implements args to produce its CLI arguments and execute to run against a Terraform client.

Required Associated Types

type Output: Send

The output type produced by this command.

Required Methods

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

Build the argument list for this command.

Returns the subcommand name followed by all flags and options. For example: ["init", "-upgrade", "-backend-config=key=value"].

fn execute( &self, tf: &Terraform, ) -> impl Future<Output = Result<Self::Output>> + Send

Execute this command against the given Terraform client.

Provided Methods

fn supports_input(&self) -> bool

Whether this command supports the -input=false flag.

Defaults to false. Commands that accept -input (init, plan, apply, destroy, import, refresh) should override this to return true.

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

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

Calls args and, if tf.no_input is set and supports_input returns true, inserts -input=false after the subcommand name.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl TerraformCommand for ApplyCommand

type Output = CommandOutput

impl TerraformCommand for DestroyCommand

type Output = CommandOutput

impl TerraformCommand for FmtCommand

type Output = CommandOutput

impl TerraformCommand for ForceUnlockCommand

type Output = CommandOutput

impl TerraformCommand for GetCommand

type Output = CommandOutput

impl TerraformCommand for GraphCommand

type Output = CommandOutput

impl TerraformCommand for ImportCommand

type Output = CommandOutput

impl TerraformCommand for InitCommand

type Output = CommandOutput

impl TerraformCommand for ModulesCommand

type Output = CommandOutput

impl TerraformCommand for OutputCommand

type Output = OutputResult

impl TerraformCommand for PlanCommand

type Output = CommandOutput

impl TerraformCommand for ProvidersCommand

type Output = CommandOutput

impl TerraformCommand for RawCommand

type Output = CommandOutput

impl TerraformCommand for RefreshCommand

type Output = CommandOutput

impl TerraformCommand for ShowCommand

type Output = ShowResult

impl TerraformCommand for StateCommand

type Output = CommandOutput

impl TerraformCommand for TestCommand

type Output = CommandOutput

impl TerraformCommand for ValidateCommand

Available on crate feature json only.

type Output = ValidationResult

impl TerraformCommand for VersionCommand

Available on crate feature json only.

type Output = VersionInfo

impl TerraformCommand for WorkspaceCommand

type Output = CommandOutput