Struct hcl::template::IfDirective

pub struct IfDirective {
    pub cond_expr: Expression,
    pub true_template: Template,
    pub false_template: Option<Template>,
    pub if_strip: Strip,
    pub else_strip: Strip,
    pub endif_strip: Strip,
}

The template if directive is the template equivalent of the conditional expression, allowing selection of one of two sub-templates based on the condition result.

Fields

cond_expr: Expression

The condition expression.

true_template: Template

The template that is included in the result string if the conditional expression evaluates to true.

false_template: Option<Template>

The template that is included in the result string if the if branch’s conditional expression evaluates to false. This is None if there is no else branch in which case the result string will be empty.

if_strip: Strip

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

else_strip: Strip

The whitespace strip mode to use on the template elements preceeding and following after the else expression. This has no effect if false_template is None.

endif_strip: Strip

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

Implementations

impl IfDirective

pub fn new<T>(cond_expr: T, true_template: Template) -> IfDirectivewhere T: Into<Expression>,

Creates a new IfDirective from a conditional expression and a template that is included in the result string if the conditional expression evaluates to true.

pub fn with_false_template<T>(self, else_template: T) -> IfDirectivewhere T: Into<Template>,

Adds a template for the else branch which is included in the result string if the condition of the IfDirective evaluates to false and returns the modified IfDirective.

pub fn with_if_strip(self, strip: Strip) -> IfDirective

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

pub fn with_else_strip(self, strip: Strip) -> IfDirective

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

pub fn with_endif_strip(self, strip: Strip) -> IfDirective

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

Trait Implementations

impl Clone for IfDirective

fn clone(&self) -> IfDirective

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IfDirective

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

Formats the value using the given formatter.

impl Format for IfDirective

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<IfDirective> for Directive

fn from(directive: IfDirective) -> Self

Converts to this type from the input type.

impl PartialEq<IfDirective> for IfDirective

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

impl StructuralEq for IfDirective

impl StructuralPartialEq for IfDirective