Struct Mapping 

pub struct Mapping { /* private fields */ }

An insertion-ordered YAML mapping whose keys and values are both Value.

Implementations

impl Mapping

pub const fn new() -> Mapping

Creates an empty mapping.

pub fn with_capacity(capacity: usize) -> Mapping

Creates an empty mapping with space for at least capacity entries.

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more entries.

pub fn shrink_to_fit(&mut self)

Shrinks the mapping’s allocation as much as possible.

pub fn capacity(&self) -> usize

Returns the allocated entry capacity.

pub fn len(&self) -> usize

Returns the number of entries.

pub fn is_empty(&self) -> bool

Returns true when there are no entries.

pub fn clear(&mut self)

Removes all entries.

pub fn insert(&mut self, key: Value, value: Value) -> Option<Value>

Inserts an entry, returning the previous value when the key existed.

pub fn contains_key<I>(&self, index: I) -> bool

where I: Index,

Returns whether the mapping contains index.

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

where I: Index,

Returns the value selected by index.

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

where I: Index,

Returns a mutable value selected by index.

pub fn entry(&mut self, key: Value) -> Entry<'_>

Returns the entry API for key.

pub fn remove<I>(&mut self, index: I) -> Option<Value>

where I: Index,

Removes an entry by swapping the last entry into its position.

pub fn remove_entry<I>(&mut self, index: I) -> Option<(Value, Value)>

where I: Index,

Removes and returns an entry by swapping the last entry into its position.

pub fn swap_remove<I>(&mut self, index: I) -> Option<Value>

where I: Index,

Removes a value by swapping the last entry into its position.

pub fn swap_remove_entry<I>(&mut self, index: I) -> Option<(Value, Value)>

where I: Index,

Removes an entry by swapping the last entry into its position.

pub fn shift_remove<I>(&mut self, index: I) -> Option<Value>

where I: Index,

Removes a value while retaining the relative order of other entries.

pub fn shift_remove_entry<I>(&mut self, index: I) -> Option<(Value, Value)>

where I: Index,

Removes an entry while retaining the relative order of other entries.

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

where F: FnMut(&Value, &mut Value) -> bool,

Retains only entries for which keep returns true.

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

Iterates over entries in insertion order.

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

Mutably iterates over entries in insertion order.

pub fn keys(&self) -> Keys<'_>

Iterates over keys in insertion order.

pub fn values(&self) -> Values<'_>

Iterates over values in insertion order.

pub fn values_mut(&mut self) -> ValuesMut<'_>

Mutably iterates over values in insertion order.

pub fn into_keys(self) -> IntoKeys

Consumes the mapping and iterates over its keys.

pub fn into_values(self) -> IntoValues

Consumes the mapping and iterates over its values.

Trait Implementations

impl Clone for Mapping

fn clone(&self) -> Mapping

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mapping

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

Formats the value using the given formatter.

impl Default for Mapping

fn default() -> Mapping

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Mapping

fn deserialize<D>( deserializer: D, ) -> Result<Mapping, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Mapping

impl Extend<(Value, Value)> for Mapping

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

where T: IntoIterator<Item = (Value, Value)>,

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<Mapping> for Value

fn from(value: Mapping) -> Value

Converts to this type from the input type.

impl FromIterator<(Value, Value)> for Mapping

fn from_iter<T>(iter: T) -> Mapping

where T: IntoIterator<Item = (Value, Value)>,

Creates a value from an iterator.

impl Hash for Mapping

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I> Index<I> for Mapping

where I: Index,

type Output = Value

The returned type after indexing.

fn index(&self, index: I) -> &<Mapping as Index<I>>::Output

Performs the indexing (container[index]) operation.

impl<I> IndexMut<I> for Mapping

where I: Index,

fn index_mut(&mut self, index: I) -> &mut <Mapping as Index<I>>::Output

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for Mapping

type Item = (Value, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter<(Value, Value)>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Mapping

type Item = (&'a Value, &'a Value)

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Mapping as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Mapping

type Item = (&'a Value, &'a mut Value)

The type of the elements being iterated over.

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut Mapping as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for Mapping

fn eq(&self, other: &Mapping) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Mapping

fn partial_cmp(&self, other: &Mapping) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Mapping

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.