Struct encon::PlainMap

pub struct PlainMap { /* fields omitted */ }

Similar to Map, but with all fields decrypted into Values.

You can acquire this by calling Map::to_plain_map with a password.

Implementations

impl PlainMap

pub fn new() -> Self

pub fn to_json_pretty(&self) -> Result<String, MapToJsonError>

Converts the PlainMap to pretty-printed JSON.

pub fn to_json_compact(&self) -> Result<String, MapToJsonError>

Similar to to_json_pretty, except printed as compactly as possible.

This is serde_json::to_string, but named explicitly since you usually want the to_json_pretty variant.

pub fn to_value(&self) -> Value

Convert this to a serde_json::Value (in the Object/Map variant).

pub fn insert(
    &mut self,
    key: impl Into<String>,
    value: impl Into<Value>
) -> Option<Value>

Insert a Value, returning the existing Value, if any.

pub fn insert_before(
    &mut self,
    index: usize,
    key: impl Into<String>,
    value: impl Into<Value>
) -> Option<Value>

Inserts the item before the specified index. If the index is >= the number of items, it's simply appended to the end.

use encon::PlainMap;

let mut map = PlainMap::new();
map.insert("foo", serde_json::json!("a"));
map.insert("baz", serde_json::json!("c"));
map.insert_before(1, "bar", serde_json::json!("b"));

let keys = map.keys().map(|k| k as &str).collect::<Vec<_>>();
assert_eq!(keys, vec!["foo", "bar", "baz"]);

pub fn keys(&self) -> impl Iterator<Item = &String>

Return an iterator over the keys of the map, in their order

pub fn values(&self) -> impl Iterator<Item = &Value>

Return an iterator over the values of the map, in their order

pub fn entry(&mut self, key: String) -> Entry<'_, String, Value>

Get the given key’s corresponding entry in the map for insertion and/or in-place manipulation.

pub fn get(&self, key: impl Into<String>) -> Option<&Value>

Return a reference to the value stored for key, if it is present, else None.

pub fn get_mut(&mut self, key: impl Into<String>) -> Option<&mut Value>

Return a mutable reference to the value stored for key, if it is present, else None.

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

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

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

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

pub fn remove(&mut self, key: impl Into<String>) -> Option<Value>

Remove the entry for this key, and return it if it exists.

pub fn sort_keys(&mut self)

Remove the entry for this key, and return it if it exists.

pub fn reverse(&mut self)

pub fn len(&self) -> usize

Returns the number of elements in the map.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Trait Implementations

impl Clone for PlainMap

fn clone(&self) -> PlainMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlainMap

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

Formats the value using the given formatter.

impl Default for PlainMap

fn default() -> PlainMap

Returns the "default value" for a type.

impl IntoIterator for PlainMap

type Item = (String, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter<String, Value>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a PlainMap

type Item = (&'a String, &'a Value)

The type of the elements being iterated over.

type IntoIter = Iter<'a, String, Value>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut PlainMap

type Item = (&'a String, &'a mut Value)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, String, Value>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.