Struct hcl_edit::expr::ForIntro

pub struct ForIntro {
    pub key_var: Option<Decorated<Ident>>,
    pub value_var: Decorated<Ident>,
    pub collection_expr: Expression,
    /* private fields */
}

The for expression introduction, containing an optional key var, value var and the collection expression that is iterated.

Fields

key_var: Option<Decorated<Ident>>

Optional name of the variable that will be temporarily assigned the key of each element during iteration. If the source collection is an array, it gets assigned the zero-based array index. For an object source collection, this gets assigned the object’s key.

value_var: Decorated<Ident>

The name of the variable that will be temporarily assigned the value of each element during iteration.

collection_expr: Expression

An expression that must evaluate to a value that can be iterated.

Implementations

impl ForIntro

pub fn new( value_var: impl Into<Decorated<Ident>>, collection_expr: impl Into<Expression> ) -> ForIntro

Creates a new ForIntro from a value variable and a collection expression.

Trait Implementations

impl Clone for ForIntro

fn clone(&self) -> ForIntro

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ForIntro

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

Formats the value using the given formatter.

impl Decorate for ForIntro

fn decor(&self) -> &Decor

Returns a reference to the object’s Decor.

fn decor_mut(&mut self) -> &mut Decor

Returns a mutable reference to the object’s Decor.

fn decorate(&mut self, decor: impl Into<Decor>)

Decorate the object with decor in-place.

fn decorated(self, decor: impl Into<Decor>) -> Selfwhere Self: Sized,

Decorate the object with decor and return the modified value.

impl PartialEq<ForIntro> for ForIntro

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Span for ForIntro

fn span(&self) -> Option<Range<usize>>

Obtains the span information. This only returns Some if the value was emitted by the parser.

impl Eq for ForIntro

impl StructuralEq for ForIntro