Struct Attribute

pub struct Attribute {
    pub key: Decorated<Ident>,
    pub value: Expression,
    /* private fields */
}

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: Decorated<Ident>

The HCL attribute’s key.

value: Expression

The value expression of the HCL attribute.

Implementations

impl Attribute

pub fn new( key: impl Into<Decorated<Ident>>, value: impl Into<Expression>, ) -> Attribute

Creates a new Attribute from a key and a value.

pub fn has_key(&self, key: &str) -> bool

Returns true if the attribute has the given key.

Example

use hcl_edit::{structure::Attribute, Ident};

let attr = Attribute::new(Ident::new("foo"), "bar");
assert!(attr.has_key("foo"));
assert!(!attr.has_key("bar"));

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 Decorate for Attribute

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 From<Attribute> for Structure

fn from(value: Attribute) -> Self

Converts to this type from the input type.

impl PartialEq for Attribute

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Span for Attribute

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 Attribute