Struct jsonbb::ObjectRef

source ·
pub struct ObjectRef<'a> { /* private fields */ }
Expand description

A reference to a JSON object.

Implementations§

source§

impl<'a> ObjectRef<'a>

source

pub fn get(self, key: &str) -> Option<ValueRef<'a>>

Returns the value associated with the given key, or None if the key is not present.

§Examples
let json: jsonbb::Value = r#"{"a": 1, "b": 2}"#.parse().unwrap();
let object = json.as_object().unwrap();
assert!(object.get("a").is_some());
assert!(object.get("c").is_none());
source

pub fn contains_key(self, key: &str) -> bool

Returns true if the object contains a value for the specified key.

§Examples
let json: jsonbb::Value = r#"{"a": 1, "b": 2}"#.parse().unwrap();
let object = json.as_object().unwrap();
assert_eq!(object.contains_key("a"), true);
assert_eq!(object.contains_key("c"), false);
source

pub fn len(self) -> usize

Returns the number of elements in the object.

§Examples
let json: jsonbb::Value = r#"{"a": 1, "b": 2}"#.parse().unwrap();
let object = json.as_object().unwrap();
assert_eq!(object.len(), 2);
source

pub fn is_empty(self) -> bool

Returns true if the object contains no elements.

§Examples
let json: jsonbb::Value = r#"{"a": 1, "b": 2}"#.parse().unwrap();
let object = json.as_object().unwrap();
assert_eq!(object.is_empty(), false);
source

pub fn iter(self) -> impl ExactSizeIterator<Item = (&'a str, ValueRef<'a>)>

Returns an iterator over the object’s key-value pairs.

§Examples
let json: jsonbb::Value = r#"{"b": 2, "a": 1}"#.parse().unwrap();
let kvs: Vec<_> = json.as_object().unwrap().iter().map(|(k, v)| (k, v.as_u64().unwrap())).collect();
assert_eq!(kvs, [("a", 1), ("b", 2)]);
source

pub fn keys(self) -> impl ExactSizeIterator<Item = &'a str>

Returns an iterator over the object’s keys.

§Examples
let json: jsonbb::Value = r#"{"b": 2, "a": 1}"#.parse().unwrap();
let keys: Vec<_> = json.as_object().unwrap().keys().collect();
assert_eq!(keys, ["a", "b"]);
source

pub fn values(self) -> impl ExactSizeIterator<Item = ValueRef<'a>>

Returns an iterator over the object’s values.

§Examples
let json: jsonbb::Value = r#"{"b": 2, "a": 1}"#.parse().unwrap();
let values: Vec<_> = json.as_object().unwrap().values().map(|v| v.as_u64().unwrap()).collect();
assert_eq!(values, [1, 2]);

Trait Implementations§

source§

impl<'a> Clone for ObjectRef<'a>

source§

fn clone(&self) -> ObjectRef<'a>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ObjectRef<'_>

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for ObjectRef<'_>

Display a JSON object as a string.

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for ObjectRef<'_>

source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for ObjectRef<'_>

source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for ObjectRef<'_>

source§

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

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

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.
source§

impl PartialOrd for ObjectRef<'_>

source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Serialize for ObjectRef<'_>

source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl<'a> Copy for ObjectRef<'a>

source§

impl Eq for ObjectRef<'_>

Auto Trait Implementations§

§

impl<'a> Freeze for ObjectRef<'a>

§

impl<'a> RefUnwindSafe for ObjectRef<'a>

§

impl<'a> Send for ObjectRef<'a>

§

impl<'a> Sync for ObjectRef<'a>

§

impl<'a> Unpin for ObjectRef<'a>

§

impl<'a> UnwindSafe for ObjectRef<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.