Struct toml_edit::Array

source ·

pub struct Array { /* private fields */ }

Expand description

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

Implementations§

source §

impl Array

Formatting

source

pub fn fmt(&mut self)

Auto formats the array.

source

pub fn set_trailing_comma(&mut self, yes: bool)

Set whether the array will use a trailing comma

source

pub fn trailing_comma(&self) -> bool

Whether the array will use a trailing comma

source

pub fn set_trailing(&mut self, trailing: impl Into<RawString>)

Set whitespace after last element

source

pub fn trailing(&self) -> &RawString

Whitespace after last element

source

pub fn decor_mut(&mut self) -> &mut Decor

Returns the surrounding whitespace

source

pub fn decor(&self) -> &Decor

Returns the surrounding whitespace

source

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

The location within the original document

This generally requires an ImDocument.

source §

impl Array

source

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

Returns an iterator over all values.

source

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

Returns an iterator over all values.

source

pub fn len(&self) -> usize

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);

source

pub fn is_empty(&self) -> bool

Return true if 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());

source

pub fn clear(&mut self)

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

source

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.

source

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

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

source

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

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");

source

pub fn push_formatted(&mut self, v: Value)

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);

source

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

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");

source

pub fn insert_formatted(&mut self, index: usize, v: Value)

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);

source

pub fn replace<V: Into<Value>>(&mut self, index: usize, v: V) -> 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");

source

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

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);

source

pub fn remove(&mut self, index: usize) -> 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);

source

pub fn retain<F>(&mut self, keep: F)
where F: FnMut(&Value) -> bool,

Retains only the values specified by the keep predicate.

In other words, remove all values for which keep(&value) returns false.

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

source

pub fn sort_by<F>(&mut self, compare: F)
where F: FnMut(&Value, &Value) -> Ordering,

Sorts the slice with a comparator function.

This sort is stable (i.e., does not reorder equal elements) and O(n * log(n)) worst-case.

The comparator function must define a total ordering for the elements in the slice. If the ordering is not total, the order of the elements is unspecified. An order is a total order if it is (for all a, b and c):

total and antisymmetric: exactly one of a < b, a == b or a > b is true, and
transitive, a < b and b < c implies a < c. The same must hold for both == and >.

For example, while f64 doesn’t implement Ord because NaN != NaN, we can use partial_cmp as our sort function when we know the slice doesn’t contain a NaN.

source