# serde_json::Map - Rust
API documentation for the Rust `Map` struct in crate `serde_json`.
Keywords: rust, rustlang, rust-lang, Map

# Struct serde_json::Map [−] [src]

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

Represents a JSON key/value type.

## Implementations

### `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 remove_entry<Q: ?Sized>(&mut self, key: &Q) -> Option<(String, Value)> where
String: Borrow<Q>,
Q: Ord + Eq + Hash,` [src]

Removes a key from the map, returning the stored key and value 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 append(&mut self, other: &mut Self)` [src]

Moves all elements from other into Self, leaving other empty.

#### `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.

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

### Notable traits for Iter<'a>

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

Gets an iterator over the entries of the map.

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

### Notable traits for IterMut<'a>

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

Gets a mutable iterator over the entries of the map.

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

### Notable traits for Keys<'a>

`impl<'a> Iterator for Keys<'a> type Item = &'a String;`
` [src]

Gets an iterator over the keys of the map.

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

### Notable traits for Values<'a>

`impl<'a> Iterator for Values<'a> type Item = &'a Value;`
` [src]

Gets an iterator over the values of the map.

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

### Notable traits for ValuesMut<'a>

`impl<'a> Iterator for ValuesMut<'a> type Item = &'a mut Value;`
` [src]

Gets an iterator over mutable values of the map.

## Trait Implementations

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

#### `fn clone(&self) -> Self` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

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

#### `fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>` [src]

Formats the value using the given formatter. Read more

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

#### `fn default() -> Self` [src]

Returns the "default value" for a type. Read more

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

#### `fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,` [src]

Deserialize this value from the given Serde deserializer. Read more

### `impl Eq for Map<String, Value>` [src]

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

#### `fn extend<T>(&mut self, iter: T) where
T: IntoIterator<Item = (String, Value)>,` [src]

Extends a collection with the contents of an iterator. Read more

#### `pub fn extend_one(&mut self, item: A)` [src]

🔬 This is a nightly-only experimental API. (`extend_one`)

Extends a collection with exactly one element.

#### `pub fn extend_reserve(&mut self, additional: usize)` [src]

🔬 This is a nightly-only experimental API. (`extend_one`)

Reserves capacity in a collection for the given number of additional elements. Read more

### `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 FromIterator<(String, Value)> for Map<String, Value>` [src]

#### `fn from_iter<T>(iter: T) -> Self where
T: IntoIterator<Item = (String, Value)>,` [src]

Creates a value from an iterator. Read more

### `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.

    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.

#### `fn index(&self, index: &Q) -> &Value` [src]

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

### `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.

    map["key"] = json!("value");

#### `fn index_mut(&mut self, index: &Q) -> &mut Value` [src]

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

### `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?

#### `fn into_iter(self) -> Self::IntoIter` [src]

Creates an iterator from a value. Read more

### `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?

#### `fn into_iter(self) -> Self::IntoIter` [src]

Creates an iterator from a value. Read more

### `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?

#### `fn into_iter(self) -> Self::IntoIter` [src]

Creates an iterator from a value. Read more

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

#### `fn eq(&self, other: &Self) -> bool` [src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `#[must_use]pub fn ne(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests for `!=`.

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

#### `fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,` [src]

Serialize this value into the given Serde serializer. Read more

## Auto Trait Implementations

### `impl<K, V> RefUnwindSafe for Map<K, V> where
K: RefUnwindSafe,
V: RefUnwindSafe,` [src]

### `impl<K, V> Send for Map<K, V> where
K: Send,
V: Send,` [src]

### `impl<K, V> Sync for Map<K, V> where
K: Sync,
V: Sync,` [src]

### `impl<K, V> Unpin for Map<K, V>` [src]

### `impl<K, V> UnwindSafe for Map<K, V> where
K: RefUnwindSafe,
V: RefUnwindSafe,` [src]

## Blanket Implementations

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

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

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

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut R

`impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`
` [src]

Immutably borrows from an owned value. Read more

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

#### `pub fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut R

`impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`
` [src]

Mutably borrows from an owned value. Read more

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

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

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

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

#### `pub fn into(self) -> U` [src]

Performs the conversion.

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

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `pub fn clone_into(&self, target: &mut T)` [src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `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.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `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.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.