Skip to main content

TerraformBuilder

Struct TerraformBuilder 

Source
pub struct TerraformBuilder { /* private fields */ }
Expand description

Builder for constructing a Terraform client.

Defaults:

  • Binary: resolved via TERRAFORM_PATH env var, or terraform on PATH
  • -no-color enabled (disable with .color(true))
  • -input=false enabled (disable with .input(true))

Implementations§

Source§

impl TerraformBuilder

Source

pub fn binary(self, path: impl Into<PathBuf>) -> Self

Set an explicit path to the terraform binary.

Source

pub fn working_dir(self, path: impl AsRef<Path>) -> Self

Set the default working directory for all commands.

This is passed as -chdir=<path> to terraform.

Source

pub fn env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set an environment variable for all terraform subprocesses.

Source

pub fn env_var(self, name: impl Into<String>, value: impl Into<String>) -> Self

Set a Terraform variable via environment (TF_VAR_<name>).

Source

pub fn color(self, enable: bool) -> Self

Enable or disable color output (default: disabled for programmatic use).

Source

pub fn input(self, enable: bool) -> Self

Enable or disable interactive input prompts (default: disabled).

Source

pub fn timeout(self, duration: Duration) -> Self

Set a default timeout for all command executions.

Commands that exceed this duration will be terminated and return Error::Timeout. No timeout is set by default.

Source

pub fn timeout_secs(self, seconds: u64) -> Self

Set a default timeout in seconds for all command executions.

Source

pub fn build(self) -> Result<Terraform>

Build the Terraform client.

Resolves the terraform binary in this order:

  1. Explicit path set via .binary()
  2. TERRAFORM_PATH environment variable
  3. terraform found on PATH

Returns Error::NotFound if the binary cannot be located.

Trait Implementations§

Source§

impl Debug for TerraformBuilder

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> 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, 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