Struct json_node::models::json_property_map::JsonPropertyMap

pub struct JsonPropertyMap(_);

Implementations

impl JsonPropertyMap

pub fn new() -> Self

Create a new property map with no mappings.

pub fn get(&self, property_name: &str) -> Option<&JsonNode>

Get the JsonNode associated with a name.

Arguments

• property_name - The name of the property you want.

Examples

use json_node::{JsonNode, JsonValue, JsonPropertyMap};
 
// Create node with mappings.
let object_node = JsonNode::Object(JsonPropertyMap::from([
    ("name".to_owned(), JsonNode::Value(JsonValue::String("John Doe".to_owned()))),
    ("age".to_owned(), JsonNode::Value(JsonValue::Integer(42))),
]));
 
let map = object_node.as_object().unwrap(); // &JsonPropertyMap.
let property = map.get("name").unwrap(); // &JsonNode.
let value = property.as_value().unwrap(); // &JsonValue.
let name = value.as_string().unwrap(); // &str.
 
assert_eq!(name, "John Doe");

pub fn get_mut(&mut self, property_name: &str) -> Option<&mut JsonNode>

Get the JsonNode associated with a name as a mutable value.

Arguments

• property_name - The name of the property you want.

Examples

use json_node::{JsonNode, JsonValue, JsonPropertyMap};
 
// Create node with mappings.
let mut object_node = JsonNode::Object(JsonPropertyMap::from([
    ("name".to_owned(), JsonNode::Value(JsonValue::String("John Doe".to_owned()))),
    ("age".to_owned(), JsonNode::Value(JsonValue::Integer(42))),
]));
 
let mut_map = object_node.as_object_mut().unwrap(); // &mut JsonPropertyMap.
let mut_property = mut_map.get_mut("name").unwrap(); // &mut JsonNode.
let mut_value = mut_property.as_value_mut().unwrap(); // &mut JsonValue.
let mut_name = mut_value.as_string_mut().unwrap(); // &mut str.
 
mut_name.make_ascii_uppercase(); // Mutates the string slice.
 
let map = object_node.as_object().unwrap(); // &JsonPropertyMap.
let property = map.get("name").unwrap(); // &JsonNode.
let value = property.as_value().unwrap(); // &JsonValue.
let name = value.as_string().unwrap(); // &String.
 
assert_eq!(name, "JOHN DOE");

pub fn add(&mut self, property_name: &str, json_node: JsonNode)

Adds a new mapping to the object.

Arguments

• property_name - Name of the new property.
• json_node - The JsonNode to be associated with the property_name.

Examples

use json_node::{JsonNode, JsonValue, JsonPropertyMap};
 
let mut map = JsonPropertyMap::new();
 
map.add("number", JsonNode::Value(JsonValue::Integer(42)));
 
let expected = JsonPropertyMap::from([
    ("number".to_owned(), JsonNode::Value(JsonValue::Integer(42)))
]);
 
assert_eq!(map, expected);

pub fn remove(&mut self, property_name: &str) -> Result<JsonNode>

Removes a mapping from the object if it exists.

Arguments

• property_name - Name of the property to be removed.

Examples

use json_node::{JsonNode, JsonValue, JsonPropertyMap};
 
let mut map = JsonPropertyMap::from([
    ("number".to_owned(), JsonNode::Value(JsonValue::Integer(42)))
]);
 
map.remove("number");
 
let expected = JsonPropertyMap::new();
assert_eq!(map, expected);

pub fn contains_property(&self, property_name: &str) -> bool

Checks if a property with the name property_name exists.

Arguments

• property_name - The name to check for.

Examples

use json_node::{JsonNode, JsonValue, JsonPropertyMap};
 
let mut map = JsonPropertyMap::from([
    ("number".to_owned(), JsonNode::Value(JsonValue::Integer(42)))
]);
 
assert!(map.contains_property("number"));
assert!(!map.contains_property("name"));

pub fn property_names(&self) -> Vec<&String>

Gets all property names in the object.

pub fn property_names_mut(&mut self) -> Vec<&mut String>

pub fn nodes(&self) -> Vec<&JsonNode>

Gets all child nodes in the object.

pub fn nodes_mut(&mut self) -> Vec<&mut JsonNode>

Gets all child nodes in the object as mutable references.

pub fn clear(&mut self)

Clears the map of all mappings.

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

Returns an iterator over the mappings represented as tuples.

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

Returns an iterator over the mappings represented as tuples that allows modifying each element and its name.

pub fn len(&self) -> usize

Returns the number of mappings in the object.

pub fn is_empty(&self) -> bool

Returns true if the object has zero mappings.

pub fn to_json_string(&self) -> String

Serialized the object as a JSON object string.

Remarks

This function does zero formatting meaning the JSON string will have no spaces or new-lines.

Trait Implementations

impl Clone for JsonPropertyMap

fn clone(&self) -> JsonPropertyMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsonPropertyMap

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

Formats the value using the given formatter.

impl<const COUNT: usize> From<[(String, JsonNode); COUNT]> for JsonPropertyMap

fn from(value: [(String, JsonNode); COUNT]) -> Self

Converts to this type from the input type.

impl From<Vec<(String, JsonNode), Global>> for JsonPropertyMap

fn from(value: Vec<(String, JsonNode)>) -> Self

Converts to this type from the input type.

impl FromIterator<(String, JsonNode)> for JsonPropertyMap

fn from_iter<T: IntoIterator<Item = (String, JsonNode)>>(iter: T) -> Self

Creates a value from an iterator.

impl Index<usize> for JsonPropertyMap

type Output = (String, JsonNode)

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for JsonPropertyMap

fn index_mut(&mut self, index: usize) -> &mut Self::Output

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

impl PartialEq<JsonPropertyMap> for JsonPropertyMap

fn eq(&self, other: &JsonPropertyMap) -> 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 StructuralPartialEq for JsonPropertyMap