[][src]Struct serde_yaml::Mapping

pub struct Mapping { /* fields omitted */ }

A YAML mapping in which the keys and values are both serde_yaml::Value.

Implementations

impl Mapping[src]

pub fn new() -> Self[src]

Creates an empty YAML map.

pub fn with_capacity(capacity: usize) -> Self[src]

Creates an empty YAML map with the given initial capacity.

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

Reserves capacity for at least additional more elements to be inserted into the map. The map may reserve more space to avoid frequent allocations.

Panics

Panics if the new allocation size overflows usize.

pub fn shrink_to_fit(&mut self)[src]

Shrinks the capacity of the map as much as possible. It will drop down as much as possible while maintaining the internal rules and possibly leaving some space in accordance with the resize policy.

pub fn insert(&mut self, k: Value, v: Value) -> Option<Value>[src]

Inserts a key-value pair into the map. If the key already existed, the old value is returned.

pub fn contains_key(&self, k: &Value) -> bool[src]

Checks if the map contains the given key.

pub fn get(&self, k: &Value) -> Option<&Value>[src]

Returns the value corresponding to the key in the map.

pub fn get_mut(&mut self, k: &Value) -> Option<&mut Value>[src]

Returns the mutable reference corresponding to the key in the map.

pub fn remove(&mut self, k: &Value) -> Option<Value>[src]

Removes and returns the value corresponding to the key from the map.

pub fn capacity(&self) -> usize[src]

Returns the maximum number of key-value pairs the map can hold without reallocating.

pub fn len(&self) -> usize[src]

Returns the number of key-value pairs in the map.

pub fn is_empty(&self) -> bool[src]

Returns whether the map is currently empty.

pub fn clear(&mut self)[src]

Clears the map of all key-value pairs.

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

Notable traits for Iter<'a>

impl<'a> Iterator for Iter<'a> type Item = (&'a Value, &'a Value);
[src]

Returns a double-ended iterator visiting all key-value pairs in order of insertion. Iterator element type is (&'a Value, &'a Value).

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

Notable traits for IterMut<'a>

impl<'a> Iterator for IterMut<'a> type Item = (&'a Value, &'a mut Value);
[src]

Returns a double-ended iterator visiting all key-value pairs in order of insertion. Iterator element type is (&'a Value, &'a mut ValuE).

Trait Implementations

impl Clone for Mapping[src]

impl Debug for Mapping[src]

impl Default for Mapping[src]

impl<'de> Deserialize<'de> for Mapping[src]

impl Eq for Mapping[src]

impl Extend<(Value, Value)> for Mapping[src]

impl From<Mapping> for Value[src]

pub fn from(f: Mapping) -> Self[src]

Convert map (with string keys) to Value

Examples

use serde_yaml::{Mapping, Value};

let mut m = Mapping::new();
m.insert("Lorem".into(), "ipsum".into());
let x: Value = m.into();

impl FromIterator<(Value, Value)> for Mapping[src]

impl Hash for Mapping[src]

impl<'a> Index<&'a Value> for Mapping[src]

type Output = Value

The returned type after indexing.

impl<'a> IndexMut<&'a Value> for Mapping[src]

impl<'a> IntoIterator for &'a Mapping[src]

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?

impl<'a> IntoIterator for &'a mut Mapping[src]

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?

impl IntoIterator for Mapping[src]

type Item = (Value, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

impl PartialEq<Mapping> for Mapping[src]

impl PartialOrd<Mapping> for Mapping[src]

impl Serialize for Mapping[src]

impl StructuralEq for Mapping[src]

impl StructuralPartialEq for Mapping[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.