Create an empty Array

Examples

let mut arr = toml_edit::Array::new();

Auto formats the array.

Set whether the array will use a trailing comma

Whether the array will use a trailing comma

Set whitespace after last element

Whitespace after last element

Returns the surrounding whitespace

Returns the surrounding whitespace

Returns an iterator over all values.

Returns an iterator over all values.

Returns the length of the underlying Vec.

In some rare cases, placeholder elements will exist. For a more accurate count, call a.iter().count()

Examples

let mut arr = toml_edit::Array::new();
arr.push(1);
arr.push("foo");
assert_eq!(arr.len(), 2);

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

Examples

let mut arr = toml_edit::Array::new();
assert!(arr.is_empty());

arr.push(1);
arr.push("foo");
assert!(! arr.is_empty());

Clears the array, removing all values. Keeps the allocated memory for reuse.

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

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

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

Examples

let mut arr = toml_edit::Array::new();
arr.push(1);
arr.push("foo");

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

Examples

let formatted_value = "'literal'".parse::<toml_edit::Value>().unwrap();
let mut arr = toml_edit::Array::new();
arr.push_formatted(formatted_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.

Panics

Panics if index > len.

Examples

let mut arr = toml_edit::Array::new();
arr.push(1);
arr.push("foo");

arr.insert(0, "start");

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

Panics

Panics if index > len.

Examples

let mut arr = toml_edit::Array::new();
arr.push(1);
arr.push("foo");

let formatted_value = "'start'".parse::<toml_edit::Value>().unwrap();
arr.insert_formatted(0, formatted_value);

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

Panics

Panics if index >= len.

Examples

let mut arr = toml_edit::Array::new();
arr.push(1);
arr.push("foo");

arr.replace(0, "start");

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

Panics

Panics if index >= len.

Examples

let mut arr = toml_edit::Array::new();
arr.push(1);
arr.push("foo");

let formatted_value = "'start'".parse::<toml_edit::Value>().unwrap();
arr.replace_formatted(0, formatted_value);

Removes the value at the given index.

Examples

let mut arr = toml_edit::Array::new();
arr.push(1);
arr.push("foo");

arr.remove(0);
assert_eq!(arr.len(), 1);