Struct toml_edit::Array

pub struct Array { /* fields omitted */ }

Type representing a TOML array, payload of the Value::Array variant’s value

Implementations

impl Array

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

Return true iff self.len() == 0.

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

Returns an iterator over all values.

pub fn push<V: Into<Value>>(&mut self, v: V) -> Result<(), Value>

Appends a new value to the end of the array, applying default formatting to it.

Returns an error if the value was of a different type than the values in the array.

pub fn push_formatted(&mut self, v: Value) -> Result<(), Value>

Appends a new, already formatted value to the end of the array.

Returns an error if the value was of a different type than the array.

pub fn insert<V: Into<Value>>(
    &mut self,
    index: usize,
    v: V
) -> Result<(), Value>

Inserts an element at the given position within the array, applying default formatting to it and shifting all values after it to the right.

Returns an error if the value was of a different type than the values in the array.

Panics if index > len.

pub fn insert_formatted(&mut self, index: usize, v: Value) -> Result<(), Value>

Inserts an already formatted value at the given position within the array, shifting all values after it to the right.

Returns an error if the value was of a different type than the values in the array.

Panics if index > len.

pub fn replace<V: Into<Value>>(
    &mut self,
    index: usize,
    v: V
) -> Result<Value, Value>

Replaces the element at the given position within the array, preserving existing formatting.

Returns an error if the replacement was of a different type than the values in the array.

Panics if index >= len.

pub fn replace_formatted(
    &mut self,
    index: usize,
    v: Value
) -> Result<Value, Value>

Replaces the element at the given position within the array with an already formatted value.

Returns an error if the replacement was of a different type than the values in the array.

Panics if index >= len.

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

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

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

Removes the value at the given index.

pub fn fmt(&mut self)

Auto formats the array.

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

fn default() -> Array

Returns the “default value” for a type.

impl Display for Array

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

Formats the value using the given formatter.

impl From<Array> for Value

fn from(array: Array) -> Self

Performs the conversion.