Struct hcl::Attribute

pub struct Attribute {
    pub key: Identifier,
    pub expr: Expression,
}

Represents an HCL attribute which consists of an attribute key and a value expression.

In HCL syntax this is represented as:

key = value

Use Attribute::new to construct an Attribute from a value that is convertible to this crate’s Expression type.

Fields

key: Identifier

The HCL attribute’s key.

expr: Expression

The value expression of the HCL attribute.

Implementations

impl Attribute

pub fn new<K, V>(key: K, expr: V) -> Attributewhere
    K: Into<Identifier>,
    V: Into<Expression>,

Creates a new Attribute from an attribute key that is convertible into a String and an attribute value that is convertible into an Expression.

pub fn key(&self) -> &str

Returns a reference to the attribute key.

pub fn expr(&self) -> &Expression

Returns a reference to the attribute value expression.

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attribute

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Attribute

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Evaluate for Attribute

type Output = Attribute

The type that is returned by evaluate on success.

fn evaluate(&self, ctx: &Context<'_>) -> EvalResult<Self::Output>

Recursively evaluates all HCL templates and expressions in the implementing type using the variables and functions declared in the Context.

impl Format for Attribute

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<K, V> From<(K, V)> for Attributewhere
    K: Into<Identifier>,
    V: Into<Expression>,

fn from((key, expr): (K, V)) -> Attribute

Converts to this type from the input type.

impl From<Attribute> for Structure

fn from(attr: Attribute) -> Structure

Converts to this type from the input type.

impl From<Attribute> for Value

fn from(attr: Attribute) -> Value

Converts to this type from the input type.

impl<'de> IntoDeserializer<'de, Error> for Attribute

type Deserializer = MapAccessDeserializer<AttributeAccess>

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl PartialEq<Attribute> for Attribute

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Attribute

impl StructuralEq for Attribute

impl StructuralPartialEq for Attribute