Enum Entry

pub enum Entry<'a> {
    Vacant(VacantEntry<'a>),
    Occupied(OccupiedEntry<'a>),
}

A view into a single entry in a map, which may either be vacant or occupied.

Variants

Vacant(VacantEntry<'a>)

A vacant Entry.

Occupied(OccupiedEntry<'a>)

An occupied Entry.

Implementations

impl<'a> Entry<'a>

pub fn or_insert<T: Into<Value>>(self, default: T) -> &'a mut Value

Ensures a value is in the entry by inserting the default if empty, Example:

use sonic_rs::object;

let mut obj = object! {};
obj.entry(&"hello").or_insert(1);
assert_eq!(obj.get(&"hello").unwrap(), 1);

obj.entry(&"hello").or_insert(2);
assert_eq!(obj.get(&"hello").unwrap(), 1);

pub fn or_insert_with<F: FnOnce() -> Value>(self, default: F) -> &'a mut Value

Ensures a value is in the entry by inserting the result of the default function if empty, Example:

use sonic_rs::Object;
let mut obj = Object::new();
obj.entry(&"hello").or_insert_with(|| 1.into());
assert_eq!(obj.get(&"hello").unwrap(), 1);

obj.entry(&"hello").or_insert_with(|| 2.into());
assert_eq!(obj.get(&"hello").unwrap(), 1);

pub fn key(&self) -> &str

Return the key of the entry.

pub fn and_modify<F: FnOnce(&mut Value)>(self, f: F) -> Self

Provides in-place mutable access to an occupied entry before any potential inserts into the object.

Examples

use sonic_rs::{object, value::object::Entry};

let mut obj = object! {"a": 0, "b": true, "c": null};
obj.entry(&"a").and_modify(|v| *v = 2.into());
assert_eq!(obj.get(&"a").unwrap(), 2);

obj.entry(&"a")
    .and_modify(|v| *v = 2.into())
    .and_modify(|v| *v = 3.into());
assert_eq!(obj.get(&"a").unwrap(), 3);

obj.entry(&"d").and_modify(|v| *v = 3.into());
assert_eq!(obj.get(&"d"), None);

obj.entry(&"d").and_modify(|v| *v = 3.into()).or_insert(4);
assert_eq!(obj.get(&"d").unwrap(), 4);

pub fn or_default(self) -> &'a mut Value

Ensures a value is in the entry by inserting the default value if empty, and returns a mutable reference to the value in the entry. # Examples

use sonic_rs::{object, value::object::Entry, Value};

let mut obj = object! {"c": null};
assert_eq!(obj.entry(&"a").or_default(), &Value::default());
assert_eq!(obj.entry(&"d").or_default(), &Value::default());

pub fn or_insert_with_key<F>(self, default: F) -> &'a mut Value

where F: FnOnce(&str) -> Value,

Ensures a value is in the entry by inserting, if empty, the result of the default function. This method allows for generating key-derived values for insertion by providing the default function a reference to the key that was moved during the .entry(key) method call.

The reference to the moved key is provided so that cloning or copying the key is unnecessary, unlike with .or_insert_with(|| ... ).

Examples

use sonic_rs::{object, Value};

let mut obj = object! {"c": null};

obj.entry(&"a")
    .or_insert_with_key(|key| Value::from(key.len()));
assert_eq!(obj.get(&"a").unwrap(), 1);

obj.entry(&"b").or_insert_with_key(|key| Value::from(key));
assert_eq!(obj.get(&"b").unwrap(), "b");