Struct Map 

pub struct Map(/* private fields */);

Conversion helper for Value::map.

This type wraps BTreeMap<Value, Value> and provides From implementations for common collection types, so that Value::map() can accept them all through a single impl Into<Map> bound.

Supported source types (where K: Into<Value>, V: Into<Value>):

• [(K, V); N] — fixed-size array of pairs
• &[(K, V)] — slice of pairs (requires K: Copy, V: Copy)
• Vec<(K, V)> — vector of pairs
• Box<[(K, V)]> — boxed slice of pairs
• BTreeMap<Value, Value> — already-sorted map (moved as-is)
• &BTreeMap<K, V> — borrowed map (requires K: Copy, V: Copy)
• &HashMap<K, V> — borrowed hash map (requires K: Copy, V: Copy)
• () — empty map

Keys and values are converted via their Into<Value> implementations. Keys are automatically sorted in CBOR canonical order.

// From a fixed-size array of pairs:
let m = Value::map([("x", 1), ("y", 2)]);

// From a Vec of pairs with mixed key types:
let pairs: Vec<(Value, Value)> = vec![
    (Value::from(1), Value::from("one")),
    (Value::from(2), Value::from("two")),
];
let m = Value::map(pairs);

// From a BTreeMap:
let mut bt = std::collections::BTreeMap::new();
bt.insert(Value::from("a"), Value::from(1));
let m = Value::map(bt);

// From a &HashMap:
let mut hm = std::collections::HashMap::new();
hm.insert(1, 2);
let m = Value::map(&hm);

// Empty map via ():
let m = Value::map(());
assert_eq!(m.len(), Some(0));

Implementations

impl Map

pub const fn new() -> Self

Create an empty map.

pub const fn get_ref(&self) -> &BTreeMap<Value, Value>

Borrow the inner BTreeMap.

pub fn get_mut(&mut self) -> &mut BTreeMap<Value, Value>

Mutably borrow the inner BTreeMap.

pub fn into_inner(self) -> BTreeMap<Value, Value>

Unwrap into the inner BTreeMap.

Trait Implementations

impl Clone for Map

fn clone(&self) -> Map

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Map

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

Formats the value using the given formatter.

impl Default for Map

fn default() -> Map

Returns the “default value” for a type.

impl<K: Into<Value> + Copy, V: Into<Value> + Copy> From<&[(K, V)]> for Map

fn from(slice: &[(K, V)]) -> Self

Converts to this type from the input type.

impl<K: Into<Value> + Copy, V: Into<Value> + Copy> From<&BTreeMap<K, V>> for Map

fn from(map: &BTreeMap<K, V>) -> Self

Converts to this type from the input type.

impl<K: Into<Value> + Copy, V: Into<Value> + Copy> From<&HashMap<K, V>> for Map

fn from(map: &HashMap<K, V>) -> Self

Converts to this type from the input type.

impl<const N: usize, K: Into<Value>, V: Into<Value>> From<[(K, V); N]> for Map

fn from(array: [(K, V); N]) -> Self

Converts to this type from the input type.

impl From<()> for Map

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<BTreeMap<Value, Value>> for Map

fn from(map: BTreeMap<Value, Value>) -> Self

Converts to this type from the input type.

impl<K: Into<Value>, V: Into<Value>> From<Box<[(K, V)]>> for Map

fn from(boxed: Box<[(K, V)]>) -> Self

Converts to this type from the input type.

impl From<Map> for Value

fn from(value: Map) -> Self

Converts to this type from the input type.

impl<K: Into<Value>, V: Into<Value>> From<Vec<(K, V)>> for Map

fn from(vec: Vec<(K, V)>) -> Self

Converts to this type from the input type.

impl PartialEq for Map

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Value> for Map

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self>

Performs the conversion.

impl Eq for Map

impl StructuralPartialEq for Map