Struct aragog::UndefinedRecord
source · pub struct UndefinedRecord(pub Value);
Expand description
Wrapper for serde_json::Value
to be treated as a Record
.
Tuple Fields§
§0: Value
Methods from Deref<Target = Value>§
sourcepub fn get<I>(&self, index: I) -> Option<&Value>where
I: Index,
pub fn get<I>(&self, index: I) -> Option<&Value>where I: Index,
Index into a JSON array or map. A string index can be used to access a value in a map, and a usize index can be used to access an element of an array.
Returns None
if the type of self
does not match the type of the
index, for example if the index is a string and self
is an array or a
number. Also returns None
if the given key does not exist in the map
or the given index is not within the bounds of the array.
let object = json!({ "A": 65, "B": 66, "C": 67 });
assert_eq!(*object.get("A").unwrap(), json!(65));
let array = json!([ "A", "B", "C" ]);
assert_eq!(*array.get(2).unwrap(), json!("C"));
assert_eq!(array.get("A"), None);
Square brackets can also be used to index into a value in a more concise
way. This returns Value::Null
in cases where get
would have returned
None
.
let object = json!({
"A": ["a", "á", "à"],
"B": ["b", "b́"],
"C": ["c", "ć", "ć̣", "ḉ"],
});
assert_eq!(object["B"][0], json!("b"));
assert_eq!(object["D"], json!(null));
assert_eq!(object[0]["x"]["y"]["z"], json!(null));
sourcepub fn get_mut<I>(&mut self, index: I) -> Option<&mut Value>where
I: Index,
pub fn get_mut<I>(&mut self, index: I) -> Option<&mut Value>where I: Index,
Mutably index into a JSON array or map. A string index can be used to access a value in a map, and a usize index can be used to access an element of an array.
Returns None
if the type of self
does not match the type of the
index, for example if the index is a string and self
is an array or a
number. Also returns None
if the given key does not exist in the map
or the given index is not within the bounds of the array.
let mut object = json!({ "A": 65, "B": 66, "C": 67 });
*object.get_mut("A").unwrap() = json!(69);
let mut array = json!([ "A", "B", "C" ]);
*array.get_mut(2).unwrap() = json!("D");
sourcepub fn is_object(&self) -> bool
pub fn is_object(&self) -> bool
Returns true if the Value
is an Object. Returns false otherwise.
For any Value on which is_object
returns true, as_object
and
as_object_mut
are guaranteed to return the map representation of the
object.
let obj = json!({ "a": { "nested": true }, "b": ["an", "array"] });
assert!(obj.is_object());
assert!(obj["a"].is_object());
// array, not an object
assert!(!obj["b"].is_object());
sourcepub fn as_object(&self) -> Option<&Map<String, Value>>
pub fn as_object(&self) -> Option<&Map<String, Value>>
If the Value
is an Object, returns the associated Map. Returns None
otherwise.
let v = json!({ "a": { "nested": true }, "b": ["an", "array"] });
// The length of `{"nested": true}` is 1 entry.
assert_eq!(v["a"].as_object().unwrap().len(), 1);
// The array `["an", "array"]` is not an object.
assert_eq!(v["b"].as_object(), None);
sourcepub fn as_object_mut(&mut self) -> Option<&mut Map<String, Value>>
pub fn as_object_mut(&mut self) -> Option<&mut Map<String, Value>>
If the Value
is an Object, returns the associated mutable Map.
Returns None otherwise.
let mut v = json!({ "a": { "nested": true } });
v["a"].as_object_mut().unwrap().clear();
assert_eq!(v, json!({ "a": {} }));
sourcepub fn is_array(&self) -> bool
pub fn is_array(&self) -> bool
Returns true if the Value
is an Array. Returns false otherwise.
For any Value on which is_array
returns true, as_array
and
as_array_mut
are guaranteed to return the vector representing the
array.
let obj = json!({ "a": ["an", "array"], "b": { "an": "object" } });
assert!(obj["a"].is_array());
// an object, not an array
assert!(!obj["b"].is_array());
sourcepub fn as_array(&self) -> Option<&Vec<Value>>
pub fn as_array(&self) -> Option<&Vec<Value>>
If the Value
is an Array, returns the associated vector. Returns None
otherwise.
let v = json!({ "a": ["an", "array"], "b": { "an": "object" } });
// The length of `["an", "array"]` is 2 elements.
assert_eq!(v["a"].as_array().unwrap().len(), 2);
// The object `{"an": "object"}` is not an array.
assert_eq!(v["b"].as_array(), None);
sourcepub fn as_array_mut(&mut self) -> Option<&mut Vec<Value>>
pub fn as_array_mut(&mut self) -> Option<&mut Vec<Value>>
If the Value
is an Array, returns the associated mutable vector.
Returns None otherwise.
let mut v = json!({ "a": ["an", "array"] });
v["a"].as_array_mut().unwrap().clear();
assert_eq!(v, json!({ "a": [] }));
sourcepub fn is_string(&self) -> bool
pub fn is_string(&self) -> bool
Returns true if the Value
is a String. Returns false otherwise.
For any Value on which is_string
returns true, as_str
is guaranteed
to return the string slice.
let v = json!({ "a": "some string", "b": false });
assert!(v["a"].is_string());
// The boolean `false` is not a string.
assert!(!v["b"].is_string());
sourcepub fn as_str(&self) -> Option<&str>
pub fn as_str(&self) -> Option<&str>
If the Value
is a String, returns the associated str. Returns None
otherwise.
let v = json!({ "a": "some string", "b": false });
assert_eq!(v["a"].as_str(), Some("some string"));
// The boolean `false` is not a string.
assert_eq!(v["b"].as_str(), None);
// JSON values are printed in JSON representation, so strings are in quotes.
//
// The value is: "some string"
println!("The value is: {}", v["a"]);
// Rust strings are printed without quotes.
//
// The value is: some string
println!("The value is: {}", v["a"].as_str().unwrap());
sourcepub fn is_number(&self) -> bool
pub fn is_number(&self) -> bool
Returns true if the Value
is a Number. Returns false otherwise.
let v = json!({ "a": 1, "b": "2" });
assert!(v["a"].is_number());
// The string `"2"` is a string, not a number.
assert!(!v["b"].is_number());
sourcepub fn as_number(&self) -> Option<&Number>
pub fn as_number(&self) -> Option<&Number>
If the Value
is a Number, returns the associated Number
. Returns
None otherwise.
let v = json!({ "a": 1, "b": 2.2, "c": -3, "d": "4" });
assert_eq!(v["a"].as_number(), Some(&Number::from(1u64)));
assert_eq!(v["b"].as_number(), Some(&Number::from_f64(2.2).unwrap()));
assert_eq!(v["c"].as_number(), Some(&Number::from(-3i64)));
// The string `"4"` is not a number.
assert_eq!(v["d"].as_number(), None);
sourcepub fn is_i64(&self) -> bool
pub fn is_i64(&self) -> bool
Returns true if the Value
is an integer between i64::MIN
and
i64::MAX
.
For any Value on which is_i64
returns true, as_i64
is guaranteed to
return the integer value.
let big = i64::max_value() as u64 + 10;
let v = json!({ "a": 64, "b": big, "c": 256.0 });
assert!(v["a"].is_i64());
// Greater than i64::MAX.
assert!(!v["b"].is_i64());
// Numbers with a decimal point are not considered integers.
assert!(!v["c"].is_i64());
sourcepub fn is_u64(&self) -> bool
pub fn is_u64(&self) -> bool
Returns true if the Value
is an integer between zero and u64::MAX
.
For any Value on which is_u64
returns true, as_u64
is guaranteed to
return the integer value.
let v = json!({ "a": 64, "b": -64, "c": 256.0 });
assert!(v["a"].is_u64());
// Negative integer.
assert!(!v["b"].is_u64());
// Numbers with a decimal point are not considered integers.
assert!(!v["c"].is_u64());
sourcepub fn is_f64(&self) -> bool
pub fn is_f64(&self) -> bool
Returns true if the Value
is a number that can be represented by f64.
For any Value on which is_f64
returns true, as_f64
is guaranteed to
return the floating point value.
Currently this function returns true if and only if both is_i64
and
is_u64
return false but this is not a guarantee in the future.
let v = json!({ "a": 256.0, "b": 64, "c": -64 });
assert!(v["a"].is_f64());
// Integers.
assert!(!v["b"].is_f64());
assert!(!v["c"].is_f64());
sourcepub fn as_i64(&self) -> Option<i64>
pub fn as_i64(&self) -> Option<i64>
If the Value
is an integer, represent it as i64 if possible. Returns
None otherwise.
let big = i64::max_value() as u64 + 10;
let v = json!({ "a": 64, "b": big, "c": 256.0 });
assert_eq!(v["a"].as_i64(), Some(64));
assert_eq!(v["b"].as_i64(), None);
assert_eq!(v["c"].as_i64(), None);
sourcepub fn as_u64(&self) -> Option<u64>
pub fn as_u64(&self) -> Option<u64>
If the Value
is an integer, represent it as u64 if possible. Returns
None otherwise.
let v = json!({ "a": 64, "b": -64, "c": 256.0 });
assert_eq!(v["a"].as_u64(), Some(64));
assert_eq!(v["b"].as_u64(), None);
assert_eq!(v["c"].as_u64(), None);
sourcepub fn as_f64(&self) -> Option<f64>
pub fn as_f64(&self) -> Option<f64>
If the Value
is a number, represent it as f64 if possible. Returns
None otherwise.
let v = json!({ "a": 256.0, "b": 64, "c": -64 });
assert_eq!(v["a"].as_f64(), Some(256.0));
assert_eq!(v["b"].as_f64(), Some(64.0));
assert_eq!(v["c"].as_f64(), Some(-64.0));
sourcepub fn is_boolean(&self) -> bool
pub fn is_boolean(&self) -> bool
Returns true if the Value
is a Boolean. Returns false otherwise.
For any Value on which is_boolean
returns true, as_bool
is
guaranteed to return the boolean value.
let v = json!({ "a": false, "b": "false" });
assert!(v["a"].is_boolean());
// The string `"false"` is a string, not a boolean.
assert!(!v["b"].is_boolean());
sourcepub fn as_bool(&self) -> Option<bool>
pub fn as_bool(&self) -> Option<bool>
If the Value
is a Boolean, returns the associated bool. Returns None
otherwise.
let v = json!({ "a": false, "b": "false" });
assert_eq!(v["a"].as_bool(), Some(false));
// The string `"false"` is a string, not a boolean.
assert_eq!(v["b"].as_bool(), None);
sourcepub fn is_null(&self) -> bool
pub fn is_null(&self) -> bool
Returns true if the Value
is a Null. Returns false otherwise.
For any Value on which is_null
returns true, as_null
is guaranteed
to return Some(())
.
let v = json!({ "a": null, "b": false });
assert!(v["a"].is_null());
// The boolean `false` is not null.
assert!(!v["b"].is_null());
sourcepub fn as_null(&self) -> Option<()>
pub fn as_null(&self) -> Option<()>
If the Value
is a Null, returns (). Returns None otherwise.
let v = json!({ "a": null, "b": false });
assert_eq!(v["a"].as_null(), Some(()));
// The boolean `false` is not null.
assert_eq!(v["b"].as_null(), None);
sourcepub fn pointer(&self, pointer: &str) -> Option<&Value>
pub fn pointer(&self, pointer: &str) -> Option<&Value>
Looks up a value by a JSON Pointer.
JSON Pointer defines a string syntax for identifying a specific value within a JavaScript Object Notation (JSON) document.
A Pointer is a Unicode string with the reference tokens separated by /
.
Inside tokens /
is replaced by ~1
and ~
is replaced by ~0
. The
addressed value is returned and if there is no such value None
is
returned.
For more information read RFC6901.
Examples
let data = json!({
"x": {
"y": ["z", "zz"]
}
});
assert_eq!(data.pointer("/x/y/1").unwrap(), &json!("zz"));
assert_eq!(data.pointer("/a/b/c"), None);
sourcepub fn pointer_mut(&mut self, pointer: &str) -> Option<&mut Value>
pub fn pointer_mut(&mut self, pointer: &str) -> Option<&mut Value>
Looks up a value by a JSON Pointer and returns a mutable reference to that value.
JSON Pointer defines a string syntax for identifying a specific value within a JavaScript Object Notation (JSON) document.
A Pointer is a Unicode string with the reference tokens separated by /
.
Inside tokens /
is replaced by ~1
and ~
is replaced by ~0
. The
addressed value is returned and if there is no such value None
is
returned.
For more information read RFC6901.
Example of Use
use serde_json::Value;
fn main() {
let s = r#"{"x": 1.0, "y": 2.0}"#;
let mut value: Value = serde_json::from_str(s).unwrap();
// Check value using read-only pointer
assert_eq!(value.pointer("/x"), Some(&1.0.into()));
// Change value with direct assignment
*value.pointer_mut("/x").unwrap() = 1.5.into();
// Check that new value was written
assert_eq!(value.pointer("/x"), Some(&1.5.into()));
// Or change the value only if it exists
value.pointer_mut("/x").map(|v| *v = 1.5.into());
// "Steal" ownership of a value. Can replace with any valid Value.
let old_x = value.pointer_mut("/x").map(Value::take).unwrap();
assert_eq!(old_x, 1.5);
assert_eq!(value.pointer("/x").unwrap(), &Value::Null);
}
Trait Implementations§
source§impl Clone for UndefinedRecord
impl Clone for UndefinedRecord
source§fn clone(&self) -> UndefinedRecord
fn clone(&self) -> UndefinedRecord
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UndefinedRecord
impl Debug for UndefinedRecord
source§impl Deref for UndefinedRecord
impl Deref for UndefinedRecord
source§impl DerefMut for UndefinedRecord
impl DerefMut for UndefinedRecord
source§impl<'de> Deserialize<'de> for UndefinedRecord
impl<'de> Deserialize<'de> for UndefinedRecord
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
source§impl From<Value> for UndefinedRecord
impl From<Value> for UndefinedRecord
source§impl Record for UndefinedRecord
impl Record for UndefinedRecord
source§const COLLECTION_NAME: &'static str = "Undefined Collection"
const COLLECTION_NAME: &'static str = "Undefined Collection"
source§fn before_create_hook<'life0, 'life1, 'async_trait, D>(
&'life0 mut self,
_db_accessor: &'life1 D
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
D: DatabaseAccess + ?Sized + 'async_trait,
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn before_create_hook<'life0, 'life1, 'async_trait, D>( &'life0 mut self, _db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,
source§fn before_save_hook<'life0, 'life1, 'async_trait, D>(
&'life0 mut self,
_db_accessor: &'life1 D
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
D: DatabaseAccess + ?Sized + 'async_trait,
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn before_save_hook<'life0, 'life1, 'async_trait, D>( &'life0 mut self, _db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,
source§fn before_delete_hook<'life0, 'life1, 'async_trait, D>(
&'life0 mut self,
_db_accessor: &'life1 D
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
D: DatabaseAccess + ?Sized + 'async_trait,
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn before_delete_hook<'life0, 'life1, 'async_trait, D>( &'life0 mut self, _db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,
source§fn after_create_hook<'life0, 'life1, 'async_trait, D>(
&'life0 mut self,
_db_accessor: &'life1 D
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
D: DatabaseAccess + ?Sized + 'async_trait,
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn after_create_hook<'life0, 'life1, 'async_trait, D>( &'life0 mut self, _db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,
source§fn after_save_hook<'life0, 'life1, 'async_trait, D>(
&'life0 mut self,
_db_accessor: &'life1 D
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
D: DatabaseAccess + ?Sized + 'async_trait,
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn after_save_hook<'life0, 'life1, 'async_trait, D>( &'life0 mut self, _db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,
source§fn after_delete_hook<'life0, 'life1, 'async_trait, D>(
&'life0 mut self,
_db_accessor: &'life1 D
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where
D: DatabaseAccess + ?Sized + 'async_trait,
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn after_delete_hook<'life0, 'life1, 'async_trait, D>( &'life0 mut self, _db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,
source§fn find<'life0, 'life1, 'async_trait, D>(
key: &'life0 str,
db_accessor: &'life1 D
) -> Pin<Box<dyn Future<Output = Result<DatabaseRecord<Self>, Error>> + Send + 'async_trait>>where
D: DatabaseAccess + ?Sized + 'async_trait,
Self: Send + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn find<'life0, 'life1, 'async_trait, D>( key: &'life0 str, db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<DatabaseRecord<Self>, Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,
source§fn get<'life0, 'life1, 'async_trait, D>(
query: &'life0 Query,
db_accessor: &'life1 D
) -> Pin<Box<dyn Future<Output = Result<QueryResult<Self>, Error>> + Send + 'async_trait>>where
D: DatabaseAccess + ?Sized + 'async_trait,
Self: Send + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn get<'life0, 'life1, 'async_trait, D>( query: &'life0 Query, db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = Result<QueryResult<Self>, Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,
source§fn get_in_batches<'life0, 'life1, 'async_trait, D>(
query: &'life0 Query,
db_accessor: &'life1 D,
batch_size: u32
) -> Pin<Box<dyn Future<Output = Result<QueryCursor<Self>, Error>> + Send + 'async_trait>>where
D: DatabaseAccess + ?Sized + 'async_trait,
Self: Send + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn get_in_batches<'life0, 'life1, 'async_trait, D>( query: &'life0 Query, db_accessor: &'life1 D, batch_size: u32 ) -> Pin<Box<dyn Future<Output = Result<QueryCursor<Self>, Error>> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,
Query
in batches.
Simple wrapper for DatabaseRecord
<T
>::get_in_batches
source§fn exists<'life0, 'life1, 'async_trait, D>(
query: &'life0 Query,
db_accessor: &'life1 D
) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>where
D: DatabaseAccess + ?Sized + 'async_trait,
Self: Send + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn exists<'life0, 'life1, 'async_trait, D>( query: &'life0 Query, db_accessor: &'life1 D ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>where D: DatabaseAccess + ?Sized + 'async_trait, Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,
Query
.
Simple wrapper for DatabaseRecord
<T
>::exists