Struct hcl_edit::structure::Body

impl Body

pub fn new() -> Self

Constructs a new, empty Body.

pub fn with_capacity(capacity: usize) -> Self

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

pub fn is_empty(&self) -> bool

Returns true if the body contains no structures.

pub fn len(&self) -> usize

Returns the number of structures in the body, also referred to as its ‘length’.

pub fn clear(&mut self)

Clears the body, removing all structures.

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

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

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

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

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

Inserts a structure at position index within the body, shifting all structures after it to the right.

Panics

Panics if index > len.

pub fn push(&mut self, structure: impl Into<Structure>)

Appends a structure to the back of the body.

Panics

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

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

Removes the last structure from the body and returns it, or None if it is empty.

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

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

Like Vec::remove, the structure is removed by shifting all of the structures 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 body structures in insertion order. The iterator element type is &'a Structure.

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

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

Trait Implementations§

impl Clone for Body

fn clone(&self) -> Body

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Body

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

Formats the value using the given formatter. Read more

impl Decorate for Body

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>) -> Selfwhere Self: Sized,

Decorate the object with decor and return the modified value.

impl Default for Body

fn default() -> Body

Returns the “default value” for a type. Read more

impl Display for Body

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

Formats the value using the given formatter. Read more

impl<T> Extend<T> for Bodywhere T: Into<Structure>,

fn extend(&mut self, iterable: I)where I: IntoIterator<Item = T>,

Extends a collection with the contents of an iterator. Read more

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. Read more

impl From<Body> for BlockBody

fn from(value: Body) -> Self

Converts to this type from the input type.

impl From<Vec<Structure, Global>> for Body

fn from(structures: Vec<Structure>) -> Self

Converts to this type from the input type.

impl<T> FromIterator<T> for Bodywhere T: Into<Structure>,

fn from_iter(iterable: I) -> Selfwhere I: IntoIterator<Item = T>,

Creates a value from an iterator. Read more

impl FromStr for Body

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more

impl<'a> IntoIterator for &'a Body

type Item = &'a Structure

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = &'a Structure> + 'a, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

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

type Item = &'a mut Structure

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = &'a mut Structure> + 'a, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

impl IntoIterator for Body

type Item = Structure

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = Structure> + 'static, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

impl PartialEq<Body> for Body

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

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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 Span for Body

fn span(&self) -> Option<Range<usize>>

Obtains the span information. This only returns Some if the value was emitted by the parser. Read more

impl Eq for Body

impl StructuralEq for Body

Auto Trait Implementations§

impl UnwindSafe for Body

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for Twhere U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for Twhere T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom for Twhere U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.