Struct json::object::Object

pub struct Object { /* fields omitted */ }

A binary tree implementation of a string -> JsonValue map. You normally don't have to interact with instances of Object, much more likely you will be using the JsonValue::Object variant, which wraps around this struct.

Methods

impl Object

pub fn new() -> Self

Create a new, empty instance of Object. Empty Object performs no allocation until a value is inserted into it.

pub fn with_capacity(capacity: usize) -> Self

Create a new Object with memory preallocated for capacity number of entries.

pub fn insert(&mut self, key: &str, value: JsonValue)

Insert a new entry, or override an existing one. Note that key has to be a &str slice and not an owned String. The internals of Object will handle the heap allocation of the key if needed for better performance.

pub fn override_last(&mut self, value: JsonValue)

Deprecated since 0.11.11

: Was only meant for internal use

pub fn get(&self, key: &str) -> Option<&JsonValue>

pub fn get_mut(&mut self, key: &str) -> Option<&mut JsonValue>

pub fn remove(&mut self, key: &str) -> Option<JsonValue>

Attempts to remove the value behind key, if successful will return the JsonValue stored behind the key.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn clear(&mut self)

Wipe the Object clear. The capacity will remain untouched.

Important traits for Iter<'a>

impl<'a> Iterator for Iter<'a> type Item = (&'a str, &'a JsonValue);

pub fn iter(&self) -> Iter

Important traits for IterMut<'a>

impl<'a> Iterator for IterMut<'a> type Item = (&'a str, &'a mut JsonValue);

pub fn iter_mut(&mut self) -> IterMut

pub fn dump(&self) -> String

Prints out the value as JSON string.

pub fn pretty(&self, spaces: u16) -> String

Pretty prints out the value as JSON string. Takes an argument that's number of spaces to indent new blocks with.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Object> for JsonValue

fn from(val: Object) -> JsonValue

Performs the conversion.

impl PartialEq<Object> for JsonValue

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

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

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

This method tests for !=.

impl<'a> PartialEq<Object> for &'a JsonValue

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

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

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

This method tests for !=.

impl PartialEq<JsonValue> for Object

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

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

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

This method tests for !=.

impl PartialEq<Object> for Object

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

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

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

This method tests for !=.

impl Debug for Object

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

Formats the value using the given formatter.

impl<'a> Index<&'a str> for Object

Implements indexing by &str to easily access object members:

Example

let value = object!{
    "foo" => "bar"
};

if let JsonValue::Object(object) = value {
  assert!(object["foo"] == "bar");
}

type Output = JsonValue

The returned type after indexing.

fn index(&self, index: &str) -> &JsonValue

Performs the indexing (container[index]) operation.

impl Index<String> for Object

type Output = JsonValue

The returned type after indexing.

fn index(&self, index: String) -> &JsonValue

Performs the indexing (container[index]) operation.

impl<'a> Index<&'a String> for Object

type Output = JsonValue

The returned type after indexing.

fn index(&self, index: &String) -> &JsonValue

Performs the indexing (container[index]) operation.

impl<'a> IndexMut<&'a str> for Object

Implements mutable indexing by &str to easily modify object members:

Example

let value = object!{};

if let JsonValue::Object(mut object) = value {
  object["foo"] = 42.into();

  assert!(object["foo"] == 42);
}

fn index_mut(&mut self, index: &str) -> &mut JsonValue

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

impl IndexMut<String> for Object

fn index_mut(&mut self, index: String) -> &mut JsonValue

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

impl<'a> IndexMut<&'a String> for Object

fn index_mut(&mut self, index: &String) -> &mut JsonValue

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