Struct Array

pub struct Array { /* private fields */ }

Type representing a HCL array.

Implementations

impl Array

pub fn new() -> Self

Constructs a new, empty Array.

pub fn with_capacity(capacity: usize) -> Self

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

pub fn is_empty(&self) -> bool

Returns true if the array contains no elements.

pub fn len(&self) -> usize

Returns the number of elements in the array, also referred to as its ‘length’.

pub fn clear(&mut self)

Clears the array, removing all values.

pub fn get(&self, index: usize) -> Option<&Expression>

Returns a reference to the value at the given index, or None if the index is out of bounds.

pub fn get_mut(&mut self, index: usize) -> Option<&mut Expression>

Returns a mutable reference to the value at the given index, or None if the index is out of bounds.

pub fn insert(&mut self, index: usize, value: impl Into<Expression>)

Inserts an element at position index within the array, shifting all elements after it to the right.

Panics

Panics if index > len.

pub fn push(&mut self, value: impl Into<Expression>)

Appends an element to the back of the array.

Panics

Panics if the new capacity exceeds isize::MAX bytes.

pub fn pop(&mut self) -> Option<Expression>

Removes the last element from the array and returns it, or None if it is empty.

pub fn remove(&mut self, index: usize) -> Expression

Removes and returns the element at position index within the array, shifting all elements after it to the left.

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

Panics

Panics if index is out of bounds.

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

An iterator visiting all values in insertion order. The iterator element type is &'a Expression.

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

An iterator visiting all values in insertion order, with mutable references to the values. The iterator element type is &'a mut Expression.

pub fn trailing(&self) -> &RawString

Return a reference to raw trailing decor before the array’s closing ].

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

Set the raw trailing decor before the array’s closing ].

pub fn trailing_comma(&self) -> bool

Returns true if the array uses a trailing comma.

pub fn set_trailing_comma(&mut self, yes: bool)

Set whether the array will use a trailing comma.

Trait Implementations

impl Clone for Array

fn clone(&self) -> Array

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Array

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

Formats the value using the given formatter.

impl Decorate for Array

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 Array

fn default() -> Array

Returns the “default value” for a type.

impl<T> Extend<T> for Array

where T: Into<Expression>,

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

where I: IntoIterator<Item = T>,

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<Array> for Expression

fn from(value: Array) -> Self

Converts to this type from the input type.

impl From<Vec<Expression>> for Array

fn from(values: Vec<Expression>) -> Self

Converts to this type from the input type.

impl<T> FromIterator<T> for Array

where T: Into<Expression>,

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

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl<'a> IntoIterator for &'a Array

type Item = &'a Expression

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = &'a Expression> + '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 Array

type Item = &'a mut Expression

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = &'a mut Expression> + '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 Array

type Item = Expression

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = Expression>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Array

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 Array

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 Array