Struct hcl_edit::expr::ForExpr

pub struct ForExpr {
    pub intro: ForIntro,
    pub key_expr: Option<Expression>,
    pub value_expr: Expression,
    pub grouping: bool,
    pub cond: Option<ForCond>,
    /* private fields */
}

A for expression is a construct for constructing a collection by projecting the items from another collection.

Fields

intro: ForIntro

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

key_expr: Option<Expression>

An expression that is evaluated once for each key in the source collection. If set, the result of the for expression will be an object. Otherwise, the result will be an array.

value_expr: Expression

An expression that is evaluated once for each value in the source collection.

grouping: bool

Indicates whether grouping mode is enabled. In grouping mode, each value in the resulting object is a list of all of the values that were produced against each distinct key. This is ignored if key_expr is None.

cond: Option<ForCond>

An optional filter expression. Elements for which the condition evaluates to true will be evaluated as normal, while if false the element will be skipped.

Implementations

impl ForExpr

pub fn new(intro: ForIntro, value_expr: impl Into<Expression>) -> ForExpr

Creates a new ForExpr from a for expression introduction and a result value expression.

Trait Implementations

impl Clone for ForExpr

fn clone(&self) -> ForExpr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ForExpr

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

Formats the value using the given formatter.

impl Decorate for ForExpr

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 From<ForExpr> for Expression

fn from(value: ForExpr) -> Self

Converts to this type from the input type.

impl PartialEq<ForExpr> for ForExpr

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 ForExpr

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 ForExpr

impl StructuralEq for ForExpr