Struct Array 

pub struct Array<'de> { /* private fields */ }

A TOML array with span information.

An Array stores Item elements in insertion order with arena-allocated backing storage. It carries the byte-offset Span from the source document.

Accessing elements

• Index operator: array[i] returns a MaybeItem that never panics on out-of-bounds access.
• get / get_mut: return Option<&Item> / Option<&mut Item>.
• Iteration: for item in &array { ... }.

Mutation

push appends an element. An Arena is required because array storage is arena-allocated.

Implementations

impl<'de> Array<'de>

pub fn new() -> Self

Creates an empty array in format-hints mode (no source span).

The array starts with automatic style: normalization will choose between inline and header (array-of-tables) based on content. Call set_style to override.

pub fn try_with_capacity(cap: usize, arena: &'de Arena) -> Option<Self>

Creates an empty array with pre-allocated capacity.

Returns None if cap exceeds u32::MAX.

pub fn span(&self) -> Span

Returns the source span, or 0..0 if this array was constructed programmatically (format-hints mode).

pub fn push(&mut self, value: Item<'de>, arena: &'de Arena)

Appends a value to the end of the array.

pub fn len(&self) -> usize

Returns the number of elements.

pub fn is_empty(&self) -> bool

Returns true if the array contains no elements.

pub fn get(&self, index: usize) -> Option<&Item<'de>>

Returns a reference to the element at the given index.

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

Returns a mutable reference to the element at the given index.

pub fn remove(&mut self, index: usize) -> Item<'de>

Removes and returns the element at index, shifting subsequent elements to the left.

Panics

Panics if index is out of bounds.

pub fn pop(&mut self) -> Option<Item<'de>>

Removes and returns the last element, or None if empty.

pub fn last_mut(&mut self) -> Option<&mut Item<'de>>

Returns a mutable reference to the last element.

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

Returns an iterator over references to the elements.

pub fn as_slice(&self) -> &[Item<'de>]

Returns the contents as a slice.

pub fn as_mut_slice(&mut self) -> &mut [Item<'de>]

Returns the contents as a mutable slice.

pub fn as_item(&self) -> &Item<'de>

Converts this Array into an Item with the same span and payload.

pub fn into_item(self) -> Item<'de>

Converts this Array into an Item with the same span and payload.

pub fn style(&self) -> ArrayStyle

Returns the ArrayStyle recorded on this array.

pub fn set_style(&mut self, kind: ArrayStyle)

Pins the ArrayStyle used when this array is emitted.

Arrays built programmatically start out with an unresolved style and emit picks a rendering from their contents. Calling this method locks in kind so the choice survives emission unchanged.

pub fn clone_in(&self, arena: &'de Arena) -> Array<'de>

Deep-clones this array into arena. Keys and strings are shared with the source.

impl<'de> Array<'de>

pub fn is_auto_style(&self) -> bool

Available on crate feature to-toml only.

Returns true if this array has automatic style resolution pending.

pub fn is_expanded(&self) -> bool

Available on crate feature to-toml only.

Returns true if this inline array should be emitted in multiline format with one element per line.

pub fn set_expanded(&mut self)

Available on crate feature to-toml only.

Marks this inline array for multiline emission.

pub fn clear_expanded(&mut self)

Available on crate feature to-toml only.

Clears the multiline emission hint.

Trait Implementations

impl Debug for Array<'_>

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

Formats the value using the given formatter.

impl<'de> Default for Array<'de>

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Index<usize> for Array<'de>

type Output = MaybeItem<'de>

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, 'de> IntoIterator for &'a Array<'de>

type Item = &'a Item<'de>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Item<'de>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'de> IntoIterator for &'a mut Array<'de>

type Item = &'a mut Item<'de>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Item<'de>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'de> IntoIterator for Array<'de>

type Item = Item<'de>

The type of the elements being iterated over.

type IntoIter = IntoIter<'de>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl ToToml for Array<'_>

Available on crate feature to-toml only.

fn to_toml<'a>(&'a self, arena: &'a Arena) -> Result<Item<'a>, ToTomlError>

Produces a TOML Item representing this value.

fn to_optional_toml<'a>( &'a self, arena: &'a Arena, ) -> Result<Option<Item<'a>>, ToTomlError>

Produces an optional TOML Item representing this value.

impl Send for Array<'_>

impl Sync for Array<'_>