Struct bc_envelope::prelude::Map

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

A CBOR map.

Keys are kept sorted by encoded CBOR form in ascending lexicographic order.

Implementations

impl Map

pub fn new() -> Map

Makes a new, empty CBOR Map.

pub fn len(&self) -> usize

Returns the number of entries in the map.

pub fn is_empty(&self) -> bool

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

Gets an iterator over the entries of the CBOR map, sorted by key.

Key sorting order is lexicographic by the key’s binary-encoded CBOR.

pub fn insert(&mut self, key: impl Into<CBOR>, value: impl Into<CBOR>)

Inserts a key-value pair into the map.

pub fn get<K, V>(&self, key: K) -> Option<V>

where K: CBOREncodable, V: CBORDecodable,

Get a value from the map, given a key.

Returns Some if the key is present in the map, None otherwise.

pub fn extract<K, V>(&self, key: K) -> Result<V, CBORError>

where K: CBOREncodable, V: CBORDecodable,

Get a value from the map, given a key.

Returns Ok if the key is present in the map, Err otherwise.

Trait Implementations

impl CBOREncodable for Map

fn cbor(&self) -> CBOR

Returns the value in CBOR symbolic representation.

fn cbor_data(&self) -> Vec<u8>

Returns the value in CBOR binary representation.

impl Clone for Map

fn clone(&self) -> Map

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Default for Map

fn default() -> Map

Returns the “default value” for a type.

impl From<Map> for CBOR

fn from(value: Map) -> CBOR

Converts to this type from the input type.

impl<T, K, V> From<T> for Map

where T: IntoIterator<Item = (K, V)>, K: CBOREncodable, V: CBOREncodable,

Convert a container to a CBOR Map where the container’s items are pairs of CBOREncodable values.

fn from(container: T) -> Map

Converts to this type from the input type.

impl PartialEq for Map

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

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

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

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

impl Eq for Map