[][src]Struct serde_json::map::Map

pub struct Map<K, V> { /* fields omitted */ }

Represents a JSON key/value type.

Methods

impl Map<String, Value>[src]

pub fn new() -> Self[src]

Makes a new empty Map.

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

Makes a new empty Map with the given initial capacity.

pub fn clear(&mut self)[src]

Clears the map, removing all values.

pub fn get<Q: ?Sized>(&self, key: &Q) -> Option<&Value> where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash
[src]

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn contains_key<Q: ?Sized>(&self, key: &Q) -> bool where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash
[src]

Returns true if the map contains a value for the specified key.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn get_mut<Q: ?Sized>(&mut self, key: &Q) -> Option<&mut Value> where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash
[src]

Returns a mutable reference to the value corresponding to the key.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

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

Inserts a key-value pair into the map.

If the map did not have this key present, None is returned.

If the map did have this key present, the value is updated, and the old value is returned.

pub fn remove<Q: ?Sized>(&mut self, key: &Q) -> Option<Value> where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash
[src]

Removes a key from the map, returning the value at the key if the key was previously in the map.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn entry<S>(&mut self, key: S) -> Entry where
    S: Into<String>, 
[src]

Gets the given key's corresponding entry in the map for in-place manipulation.

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

Returns the number of elements in the map.

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

Returns true if the map contains no elements.

Important traits for Iter<'a>
pub fn iter(&self) -> Iter[src]

Gets an iterator over the entries of the map.

Important traits for IterMut<'a>
pub fn iter_mut(&mut self) -> IterMut[src]

Gets a mutable iterator over the entries of the map.

Important traits for Keys<'a>
pub fn keys(&self) -> Keys[src]

Gets an iterator over the keys of the map.

Important traits for Values<'a>
pub fn values(&self) -> Values[src]

Gets an iterator over the values of the map.

Important traits for ValuesMut<'a>
pub fn values_mut(&mut self) -> ValuesMut[src]

Gets an iterator over mutable values of the map.

Trait Implementations

impl Default for Map<String, Value>[src]

impl Clone for Map<String, Value>[src]

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

impl PartialEq<Map<String, Value>> for Map<String, Value>[src]

impl<'a> IntoIterator for &'a Map<String, Value>[src]

type Item = (&'a String, &'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 Map<String, Value>[src]

type Item = (&'a String, &'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 Map<String, Value>[src]

type Item = (String, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

impl From<Map<String, Value>> for Value[src]

fn from(f: Map<String, Value>) -> Self[src]

Convert map (with string keys) to Value

Examples

use serde_json::{Map, Value};

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

impl<'a, Q: ?Sized> Index<&'a Q> for Map<String, Value> where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash
[src]

Access an element of this map. Panics if the given key is not present in the map.

# use serde_json::Value;
#
# let val = &Value::String("".to_owned());
# let _ =
match *val {
    Value::String(ref s) => Some(s.as_str()),
    Value::Array(ref arr) => arr[0].as_str(),
    Value::Object(ref map) => map["type"].as_str(),
    _ => None,
}
# ;

type Output = Value

The returned type after indexing.

impl<'a, Q: ?Sized> IndexMut<&'a Q> for Map<String, Value> where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash
[src]

Mutably access an element of this map. Panics if the given key is not present in the map.

# use serde_json::json;
#
# let mut map = serde_json::Map::new();
# map.insert("key".to_owned(), serde_json::Value::Null);
#
map["key"] = json!("value");

impl Debug for Map<String, Value>[src]

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

impl Serialize for Map<String, Value>[src]

impl<'de> Deserialize<'de> for Map<String, Value>[src]

Auto Trait Implementations

impl<K, V> Send for Map<K, V> where
    K: Send,
    V: Send

impl<K, V> Unpin for Map<K, V> where
    K: Unpin,
    V: Unpin

impl<K, V> Sync for Map<K, V> where
    K: Sync,
    V: Sync

impl<K, V> UnwindSafe for Map<K, V> where
    K: RefUnwindSafe + UnwindSafe,
    V: RefUnwindSafe + UnwindSafe

impl<K, V> RefUnwindSafe for Map<K, V> where
    K: RefUnwindSafe,
    V: RefUnwindSafe

Blanket Implementations

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

type Owned = T

The resulting type after obtaining ownership.

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

impl<I> IntoIterator for I where
    I: Iterator
[src]

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = I

Which kind of iterator are we turning this into?

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

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.

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

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

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

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