Enum hcl_edit::expr::Expression

pub enum Expression {
    Null(Decorated<Null>),
    Bool(Decorated<bool>),
    Number(Formatted<Number>),
    String(Decorated<String>),
    Array(Array),
    Object(Object),
    StringTemplate(StringTemplate),
    HeredocTemplate(Box<HeredocTemplate>),
    Parenthesis(Box<Parenthesis>),
    Variable(Decorated<Ident>),
    Conditional(Box<Conditional>),
    FuncCall(Box<FuncCall>),
    Traversal(Box<Traversal>),
    UnaryOp(Box<UnaryOp>),
    BinaryOp(Box<BinaryOp>),
    ForExpr(Box<ForExpr>),
}

A type representing any expression from the expression sub-language.

Variants

Null(Decorated<Null>)

Represents a null value.

Bool(Decorated<bool>)

Represents a boolean.

Number(Formatted<Number>)

Represents a number, either integer or float.

String(Decorated<String>)

Represents a string that does not contain any template interpolations or template directives.

Array(Array)

Represents an HCL array.

Object(Object)

Represents an HCL object.

StringTemplate(StringTemplate)

Represents a string containing template interpolations and template directives.

HeredocTemplate(Box<HeredocTemplate>)

Represents an HCL heredoc template.

Parenthesis(Box<Parenthesis>)

Represents a sub-expression wrapped in parenthesis.

Variable(Decorated<Ident>)

Represents a variable identifier.

Conditional(Box<Conditional>)

Represents conditional operator which selects one of two rexpressions based on the outcome of a boolean expression.

FuncCall(Box<FuncCall>)

Represents a function call.

Traversal(Box<Traversal>)

Represents an attribute or element traversal.

UnaryOp(Box<UnaryOp>)

Represents an operation which applies a unary operator to an expression.

BinaryOp(Box<BinaryOp>)

Represents an operation which applies a binary operator to two expressions.

ForExpr(Box<ForExpr>)

Represents a construct for constructing a collection by projecting the items from another collection.

Implementations

impl Expression

pub fn null() -> Expression

Creates a null expression.

pub fn is_null(&self) -> bool

Returns true if the expression represents null.

pub fn is_bool(&self) -> bool

Returns true if the expression is a bool.

pub fn as_bool(&self) -> Option<bool>

If the expression is a bool, returns a reference to it, otherwise None.

pub fn is_number(&self) -> bool

Returns true if the expression is a number.

pub fn as_number(&self) -> Option<&Number>

If the expression is a number, returns a reference to it, otherwise None.

pub fn is_str(&self) -> bool

Returns true if the expression is a string.

pub fn as_str(&self) -> Option<&str>

If the expression is a string, returns a reference to it, otherwise None.

pub fn is_array(&self) -> bool

Returns true if the expression is an array.

pub fn as_array(&self) -> Option<&Array>

If the expression is an array, returns a reference to it, otherwise None.

pub fn as_array_mut(&mut self) -> Option<&mut Array>

If the expression is an array, returns a mutable reference to it, otherwise None.

pub fn is_object(&self) -> bool

Returns true if the expression is an object.

pub fn as_object(&self) -> Option<&Object>

If the expression is an object, returns a reference to it, otherwise None.

pub fn as_object_mut(&mut self) -> Option<&mut Object>

If the expression is an object, returns a mutable reference to it, otherwise None.

pub fn is_template(&self) -> bool

Returns true if the expression is either of variant StringTemplate or HeredocTemplate.

pub fn as_template(&self) -> Option<&Template>

If the expression is either of variant StringTemplate or HeredocTemplate, returns a reference to the underlying Template, otherwise None.

pub fn is_string_template(&self) -> bool

Returns true if the expression is a string template.

pub fn as_string_template(&self) -> Option<&StringTemplate>

If the expression is a string template, returns a reference to it, otherwise None.

pub fn is_heredoc_template(&self) -> bool

Returns true if the expression is a heredoc template.

pub fn as_heredoc_template(&self) -> Option<&HeredocTemplate>

If the expression is a heredoc template, returns a reference to it, otherwise None.

pub fn is_parenthesis(&self) -> bool

Returns true if the expression is wrapped in parenthesis.

pub fn as_parenthesis(&self) -> Option<&Parenthesis>

If the expression is an expression wrapped in parenthesis, returns a reference to it, otherwise None.

pub fn is_variable(&self) -> bool

Returns true if the expression is a variable.

pub fn as_variable(&self) -> Option<&Ident>

If the expression is a variable, returns a reference to it, otherwise None.

pub fn is_conditional(&self) -> bool

Returns true if the expression is a conditional.

pub fn as_conditional(&self) -> Option<&Conditional>

If the expression is a conditional, returns a reference to it, otherwise None.

pub fn is_func_call(&self) -> bool

Returns true if the expression is a function call.

pub fn as_func_call(&self) -> Option<&FuncCall>

If the expression is a function call, returns a reference to it, otherwise None.

pub fn is_traversal(&self) -> bool

Returns true if the expression is a traversal.

pub fn as_traversal(&self) -> Option<&Traversal>

If the expression is a traversal, returns a reference to it, otherwise None.

pub fn is_unary_op(&self) -> bool

Returns true if the expression is a unary op.

pub fn as_unary_op(&self) -> Option<&UnaryOp>

If the expression is a unary op, returns a reference to it, otherwise None.

pub fn is_binary_op(&self) -> bool

Returns true if the expression is a binary op.

pub fn as_binary_op(&self) -> Option<&BinaryOp>

If the expression is a binary op, returns a reference to it, otherwise None.

pub fn is_for_expr(&self) -> bool

Returns true if the expression is a for expression.

pub fn as_for_expr(&self) -> Option<&ForExpr>

If the expression is a for expression, returns a reference to it, otherwise None.

Trait Implementations

impl Clone for Expression

fn clone(&self) -> Expression

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Expression

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

Formats the value using the given formatter.

impl Decorate for Expression

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>) -> Self

where Self: Sized,

Decorate the object with decor and return the modified value.

impl Display for Expression

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

Formats the value using the given formatter.

impl<'a, T> From<&'a [T]> for Expression

where T: Clone + Into<Expression>,

fn from(value: &'a [T]) -> Self

Converts to this type from the input type.

impl From<&str> for Expression

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Array> for Expression

fn from(value: Array) -> Self

Converts to this type from the input type.

impl From<BinaryOp> for Expression

fn from(value: BinaryOp) -> Self

Converts to this type from the input type.

impl From<Conditional> for Expression

fn from(value: Conditional) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for Expression

fn from(s: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl From<Decorated<Ident>> for Expression

fn from(value: Decorated<Ident>) -> Self

Converts to this type from the input type.

impl From<Decorated<String>> for Expression

fn from(value: Decorated<String>) -> Self

Converts to this type from the input type.

impl From<Decorated<bool>> for Expression

fn from(value: Decorated<bool>) -> Self

Converts to this type from the input type.

impl From<Expression> for ForCond

fn from(value: Expression) -> Self

Converts to this type from the input type.

impl From<Expression> for ObjectKey

fn from(expr: Expression) -> Self

Converts to this type from the input type.

impl From<Expression> for ObjectValue

fn from(expr: Expression) -> Self

Converts to this type from the input type.

impl From<ForExpr> for Expression

fn from(value: ForExpr) -> Self

Converts to this type from the input type.

impl From<Formatted<Number>> for Expression

fn from(value: Formatted<Number>) -> Self

Converts to this type from the input type.

impl From<FuncCall> for Expression

fn from(value: FuncCall) -> Self

Converts to this type from the input type.

impl From<HeredocTemplate> for Expression

fn from(value: HeredocTemplate) -> Self

Converts to this type from the input type.

impl From<Ident> for Expression

fn from(value: Ident) -> Self

Converts to this type from the input type.

impl From<Number> for Expression

fn from(value: Number) -> Self

Converts to this type from the input type.

impl From<Object> for Expression

fn from(value: Object) -> Self

Converts to this type from the input type.

impl From<Parenthesis> for Expression

fn from(value: Parenthesis) -> Self

Converts to this type from the input type.

impl From<String> for Expression

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<StringTemplate> for Expression

fn from(value: StringTemplate) -> Self

Converts to this type from the input type.

impl From<Traversal> for Expression

fn from(value: Traversal) -> Self

Converts to this type from the input type.

impl From<UnaryOp> for Expression

fn from(value: UnaryOp) -> Self

Converts to this type from the input type.

impl<T> From<Vec<T>> for Expression

where T: Into<Expression>,

fn from(value: Vec<T>) -> Self

Converts to this type from the input type.

impl From<bool> for Expression

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Expression

fn from(f: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Expression

fn from(f: f64) -> Self

Converts to this type from the input type.

impl From<i16> for Expression

fn from(n: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Expression

fn from(n: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Expression

fn from(n: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Expression

fn from(n: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Expression

fn from(n: isize) -> Self

Converts to this type from the input type.

impl From<u16> for Expression

fn from(n: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Expression

fn from(n: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Expression

fn from(n: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Expression

fn from(n: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Expression

fn from(n: usize) -> Self

Converts to this type from the input type.

impl<K: Into<ObjectKey>, V: Into<ObjectValue>> FromIterator<(K, V)> for Expression

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Into<Expression>> FromIterator<T> for Expression

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl FromStr for Expression

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Expression

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

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 Expression

impl StructuralPartialEq for Expression