Struct ArrayOfTables

pub struct ArrayOfTables { /* private fields */ }

Available on crate feature dep_toml_edit only.

Type representing a TOML array of tables

Implementations

impl ArrayOfTables

Constructors

See also FromIterator

pub fn new() -> ArrayOfTables

Creates an empty array of tables.

impl ArrayOfTables

Formatting

pub fn into_array(self) -> Array

Convert to an inline array

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

The location within the original document

This generally requires an ImDocument.

impl ArrayOfTables

pub fn iter(&self) -> Box<dyn Iterator<Item = &Table> + '_>

Returns an iterator over tables.

pub fn iter_mut(&mut self) -> Box<dyn Iterator<Item = &mut Table> + '_>

Returns an iterator over tables.

pub fn len(&self) -> usize

Returns the length of the underlying Vec. To get the actual number of items use a.iter().count().

pub fn is_empty(&self) -> bool

Returns true if self.len() == 0.

pub fn clear(&mut self)

Removes all the tables.

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

Returns an optional reference to the table.

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

Returns an optional mutable reference to the table.

pub fn push(&mut self, table: Table)

Appends a table to the array.

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

Removes a table with the given index.

pub fn retain<F>(&mut self, keep: F)

where F: FnMut(&Table) -> bool,

Retains only the elements specified by the keep predicate.

In other words, remove all tables for which keep(&table) returns false.

This method operates in place, visiting each element exactly once in the original order, and preserves the order of the retained elements.

Trait Implementations

impl Clone for ArrayOfTables

fn clone(&self) -> ArrayOfTables

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArrayOfTables

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

Formats the value using the given formatter.

impl Default for ArrayOfTables

fn default() -> ArrayOfTables

Returns the “default value” for a type.

impl Display for ArrayOfTables

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

Formats the value using the given formatter.

impl Extend<Table> for ArrayOfTables

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = Table>,

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<ArrayOfTables> for Item

fn from(s: ArrayOfTables) -> Item

Converts to this type from the input type.

impl FromIterator<Table> for ArrayOfTables

fn from_iter<I>(iter: I) -> ArrayOfTables

where I: IntoIterator<Item = Table>,

Creates a value from an iterator.

impl<'s> IntoIterator for &'s ArrayOfTables

type Item = &'s Table

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = &'s Table> + 's>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'s ArrayOfTables as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for ArrayOfTables

type Item = Table

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <ArrayOfTables as IntoIterator>::IntoIter

Creates an iterator from a value.