Struct Object

pub struct Object { /* private fields */ }

Type representing a HCL object.

Implementations

impl Object

pub fn new() -> Self

Constructs a new, empty Object.

pub fn with_capacity(capacity: usize) -> Self

Constructs a new, empty Object with at least the specified capacity.

pub fn is_empty(&self) -> bool

Returns true if the object contains no items.

pub fn len(&self) -> usize

Returns the number of items in the object, also referred to as its ‘length’.

pub fn clear(&mut self)

Clears the object, removing all items.

pub fn contains_key(&self, key: &ObjectKey) -> bool

Return true if an equivalent to key exists in the object.

pub fn get(&self, key: &ObjectKey) -> Option<&ObjectValue>

Return a reference to the value stored for key, if it is present, else None.

pub fn get_mut(&mut self, key: &ObjectKey) -> Option<&mut ObjectValue>

Return a mutable reference to the value stored for key, if it is present, else None.

pub fn get_key_value( &self, key: &ObjectKey, ) -> Option<(&ObjectKey, &ObjectValue)>

Return references to the key-value pair stored for key, if it is present, else None.

pub fn get_key_value_mut<'a>( &'a mut self, key: &ObjectKey, ) -> Option<(ObjectKeyMut<'a>, &'a mut ObjectValue)>

Return mutable references to the key-value pair stored for key, if it is present, else None.

pub fn insert( &mut self, key: impl Into<ObjectKey>, value: impl Into<ObjectValue>, ) -> Option<ObjectValue>

Insert a key-value pair into the object.

If an equivalent key already exists in the object: the key remains and retains in its place in the order, its corresponding value is updated with value and the older value is returned inside Some(_).

If no equivalent key existed in the object: the new key-value pair is inserted, last in order, and None is returned.

pub fn remove(&mut self, key: &ObjectKey) -> Option<ObjectValue>

Remove the key-value pair equivalent to key and return its value.

Like Vec::remove, the pair is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

pub fn remove_entry( &mut self, key: &ObjectKey, ) -> Option<(ObjectKey, ObjectValue)>

Remove and return the key-value pair equivalent to key.

Like Vec::remove, the pair is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

pub fn iter(&self) -> ObjectIter<'_>

An iterator visiting all key-value pairs in insertion order. The iterator element type is (&'a ObjectKey, &'a ObjectValue).

pub fn iter_mut(&mut self) -> ObjectIterMut<'_>

An iterator visiting all key-value pairs in insertion order, with mutable references to the values. The iterator element type is (ObjectKeyMut<'a>, &'a mut ObjectValue).

pub fn trailing(&self) -> &RawString

Return a reference to raw trailing decor before the object’s closing }.

pub fn set_trailing(&mut self, trailing: impl Into<RawString>)

Set the raw trailing decor before the object’s closing }.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Object

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.

impl Decorate for Object

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 Default for Object

fn default() -> Object

Returns the “default value” for a type.

impl<K, V> Extend<(K, V)> for Object

where K: Into<ObjectKey>, V: Into<ObjectValue>,

fn extend<I>(&mut self, iterable: I)

where I: IntoIterator<Item = (K, V)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Object> for Expression

fn from(value: Object) -> Self

Converts to this type from the input type.

impl From<VecMap<ObjectKey, ObjectValue>> for Object

fn from(items: VecMap<ObjectKey, ObjectValue>) -> Self

Converts to this type from the input type.

impl<K, V> FromIterator<(K, V)> for Object

where K: Into<ObjectKey>, V: Into<ObjectValue>,

fn from_iter<I>(iterable: I) -> Self

where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

impl<'a> IntoIterator for &'a Object

type Item = (&'a ObjectKey, &'a ObjectValue)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = (&'a ObjectKey, &'a ObjectValue)> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Object

type Item = (ObjectKeyMut<'a>, &'a mut ObjectValue)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = (ObjectKeyMut<'a>, &'a mut ObjectValue)> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Object

type Item = (ObjectKey, ObjectValue)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = (ObjectKey, ObjectValue)>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Object

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 Object

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 Object