Struct hcl::template::ForDirective

pub struct ForDirective {
    pub key_var: Option<Identifier>,
    pub value_var: Identifier,
    pub collection_expr: Expression,
    pub template: Template,
    pub for_strip: StripMode,
    pub endfor_strip: StripMode,
}

The template for directive is the template equivalent of the for expression, producing zero or more copies of its sub-template based on the elements of a collection.

Fields

key_var: Option<Identifier>

Optional iterator key variable identifier.

value_var: Identifier

The iterator value variable identifier.

collection_expr: Expression

The expression that produces the list or object of elements to iterate over.

template: Template

The template that is included in the result string for each loop iteration.

for_strip: StripMode

The whitespace strip mode to use on the template elements preceeding and following after the for expression.

endfor_strip: StripMode

The whitespace strip mode to use on the template elements preceeding and following after the endfor marker of this directive.

Implementations

impl ForDirective

pub fn new<T>(
    value: Identifier,
    collection_expr: T,
    template: Template
) -> ForDirectivewhere
    T: Into<Expression>,

Creates a new ForDirective from the provided iterator value identifier, an expression that produces the list or object of elements to iterate over, and the template the is included in the result string for each loop iteration.

pub fn with_key_var(self, key_var: Identifier) -> ForDirective

Adds the iterator key variable identifier to the for expression and returns the modified ForDirective.

pub fn with_for_strip(self, strip: StripMode) -> ForDirective

Sets the whitespace strip mode to use on the template elements preceeding and following after the for expression and returns the modified ForDirective.

pub fn with_endfor_strip(self, strip: StripMode) -> ForDirective

Sets the whitespace strip mode to use on the template elements preceeding and following after the endfor marker of this directive and returns the modified ForDirective.

Trait Implementations

impl Clone for ForDirective

fn clone(&self) -> ForDirective

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ForDirective

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

Formats the value using the given formatter.

impl Format for ForDirective

fn format<W>(&self, fmt: &mut Formatter<'_, W>) -> Result<()>where
    W: Write,

Formats a HCL structure using a formatter and writes the result to the provided writer.

fn format_vec<W>(&self, fmt: &mut Formatter<'_, W>) -> Result<Vec<u8>>where
    W: Write + AsMut<Vec<u8>>,

Formats a HCL structure using a formatter and returns the result as a Vec<u8>.

fn format_string<W>(&self, fmt: &mut Formatter<'_, W>) -> Result<String>where
    W: Write + AsMut<Vec<u8>>,

Formats a HCL structure using a formatter and returns the result as a String.

impl From<ForDirective> for Directive

fn from(directive: ForDirective) -> Self

Converts to this type from the input type.

impl PartialEq<ForDirective> for ForDirective

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

impl StructuralEq for ForDirective

impl StructuralPartialEq for ForDirective