Struct Variable 

#[non_exhaustive]
pub struct Variable {
    pub name: Arc<str>,
    pub description: Option<Arc<str>>,
    pub type_expr: Option<Expression>,
    pub default: Option<Expression>,
    pub sensitive: bool,
    pub span: Span,
}

A variable "name" {} declaration inside a component.

Debug redacts default when sensitive == true, per 10-data-model.md § 2.5 (I-IR-8).

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.

name: Arc<str>

Variable name.

description: Option<Arc<str>>

Optional description = "...".

type_expr: Option<Expression>

Optional type = ... expression (kept as-is; we do not parse the HCL type-constructor mini-language in Phase 1).

default: Option<Expression>

Optional default = ... value. Pre-evaluation this is an Expression; post-evaluation it may be reduced to a Value.

sensitive: bool

Whether the variable was declared sensitive = true.

span: Span

Span of the variable keyword.

Implementations

impl Variable

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

Create a builder for building Variable. On the builder, call .name(...), .description(...)(optional), .type_expr(...)(optional), .default(...)(optional), .sensitive(...)(optional), .span(...) to set the values of the fields. Finally, call .build() to create the instance of Variable.

Trait Implementations

impl Clone for Variable

fn clone(&self) -> Variable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Variable

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Variable

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Variable

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

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 Variable