Struct FuncArgs

pub struct FuncArgs { /* private fields */ }

Type representing the arguments of a function call.

In the HCL grammar, function arguments are delimited by ( and ).

Implementations

impl FuncArgs

pub fn new() -> Self

Constructs new, empty FuncArgs.

pub fn with_capacity(capacity: usize) -> Self

Constructs new, empty FuncArgs with at least the specified capacity.

pub fn is_empty(&self) -> bool

Returns true if the function arguments are empty.

pub fn len(&self) -> usize

Returns the number of function arguments, also referred to as its ‘length’.

pub fn clear(&mut self)

Clears the function arguments.

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

Returns a reference to the argument 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 argument at the given index, or None if the index is out of bounds.

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

Inserts an argument at position index, shifting all arguments after it to the right.

Panics

Panics if index > len.

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

Removes the last argument and returns it, or None if it is empty.

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

Appends an argument.

Panics

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

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

Removes and returns the argument at position index, shifting all arguments after it to the left.

Like Vec::remove, the argument is removed by shifting all of the arguments 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 expand_final(&self) -> bool

Returns true if the final argument is a ... list expansion.

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

Set whether the final argument should be a ... list expansion.

pub fn trailing(&self) -> &RawString

Return a reference to raw trailing decor before the function argument’s closing ).

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

Set the raw trailing decor before the function argument’s closing ).

pub fn trailing_comma(&self) -> bool

Returns true if the function arguments use a trailing comma.

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

Set whether the function arguments will use a trailing comma.

Trait Implementations

impl Clone for FuncArgs

fn clone(&self) -> FuncArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FuncArgs

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

Formats the value using the given formatter.

impl Decorate for FuncArgs

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 FuncArgs

fn default() -> FuncArgs

Returns the “default value” for a type.

impl<T> Extend<T> for FuncArgs

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<Vec<Expression>> for FuncArgs

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

Converts to this type from the input type.

impl<T> FromIterator<T> for FuncArgs

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 FuncArgs

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 FuncArgs

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 FuncArgs

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 FuncArgs

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 FuncArgs

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 FuncArgs