Struct ijson::object::IObject

#[repr(transparent)]
pub struct IObject(_);

The IObject type is similar to a HashMap<IString, IValue>. As with the IArray, the length and capacity are stored inside the heap allocation. In addition, IObjects preserve the insertion order of their elements, in case that is important in the original JSON.

Removing from an IObject will disrupt the insertion order.

Implementations

impl IObject

pub fn new() -> Self

Constructs a new empty IObject. Does not allocate.

pub fn with_capacity(cap: usize) -> Self

Constructs a new IObject with the specified capacity. At least that many entries can be added to the object without reallocating.

pub fn capacity(&self) -> usize

Returns the capacity of the object. This is the maximum number of entries the object can hold without reallocating.

pub fn len(&self) -> usize

Returns the number of entries currently stored in the object.

pub fn is_empty(&self) -> bool

Returns true if the object is empty.

pub fn reserve(&mut self, additional: usize)

Reserves space for at least this many additional entries.

pub fn entry(&mut self, key: impl Into<IString>) -> Entry<'_>

Returns a view of an entry within this object.

pub fn entry_or_clone(&mut self, key: &IString) -> Entry<'_>

Returns a view of an entry within this object, whilst avoiding cloning the key if the entry is already occupied.

pub fn keys(&self) -> impl Iterator<Item = &IString>

Returns an iterator over references to the keys in this object.

pub fn values(&self) -> impl Iterator<Item = &IValue>

Returns an iterator over references to the values in this object.

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

Returns an iterator over (&key, &value) pairs in this object.

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut IValue>

Returns an iterator over mutable references to the values in this object.

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

Returns an iterator over (&key, &mut value) pairs in this object.

pub fn clear(&mut self)

Removes all entries from the object. The capacity is unchanged.

pub fn get_key_value(&self, k: impl ObjectIndex) -> Option<(&IString, &IValue)>

Looks up the specified key in this object and returns a (&key, &value) pair if found.

pub fn get_key_value_mut(
    &mut self,
    k: impl ObjectIndex
) -> Option<(&IString, &mut IValue)>

Looks up the specified key in this object and returns a (&key, &mut value) pair if found.

pub fn get(&self, k: impl ObjectIndex) -> Option<&IValue>

Looks up the specified key in this object and returns a reference to the corresponding value if found.

pub fn get_mut(&mut self, k: impl ObjectIndex) -> Option<&mut IValue>

Looks up the specified key in this object and returns a mutable reference to the corresponding value if found.

pub fn contains_key(&self, k: impl ObjectIndex) -> bool

Returns true if the specified key exists in the object.

pub fn insert(
    &mut self,
    k: impl Into<IString>,
    v: impl Into<IValue>
) -> Option<IValue>

Inserts a new value into this object with the specified key. If a value already existed at this key, that value is replaced and returend.

pub fn remove_entry(&mut self, k: impl ObjectIndex) -> Option<(IString, IValue)>

Removes the entry at the specified key, returning both the key and value if found.

pub fn remove(&mut self, k: impl ObjectIndex) -> Option<IValue>

Removes the entry at the specified key, returning the value if found.

pub fn shrink_to_fit(&mut self)

Shrinks the memory allocation used by the object such that its capacity becomes equal to its length.

pub fn retain(&mut self, f: impl FnMut(&IString, &mut IValue) -> bool)

Calls the specified function for each entry in the object. Each entry where the function returns false is removed from the object.

The function also has the ability to modify the values in-place.

Trait Implementations

impl AsMut<IValue> for IObject

fn as_mut(&mut self) -> &mut IValue

Performs the conversion.

impl AsRef<IValue> for IObject

fn as_ref(&self) -> &IValue

Performs the conversion.

impl Borrow<IValue> for IObject

fn borrow(&self) -> &IValue

Immutably borrows from an owned value.

impl BorrowMut<IValue> for IObject

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

Mutably borrows from an owned value.

impl Clone for IObject

fn clone(&self) -> IObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IObject

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

Formats the value using the given formatter.

impl Default for IObject

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IObject

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'de> Deserializer<'de> for &'de IObject

type Error = Error

The error type that can be returned if some error occurs during deserialization.

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

fn deserialize_enum<V>(
    self,
    _name: &'static str,
    _variants: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

fn deserialize_newtype_struct<V>(
    self,
    _name: &'static str,
    visitor: V
) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a newtype struct with a particular name.

fn deserialize_bool<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a bool value.

fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_i128<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_u128<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an u128 value.

fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_string<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an optional value.

fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a unit value.

fn deserialize_unit_struct<V>(
    self,
    name: &'static str,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a unit struct with a particular name.

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a sequence of values.

fn deserialize_tuple<V>(
    self,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

fn deserialize_tuple_struct<V>(
    self,
    name: &'static str,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a map of key-value pairs.

fn deserialize_struct<V>(
    self,
    name: &'static str,
    fields: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a struct with a particular name and fields.

fn deserialize_identifier<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

fn deserialize_ignored_any<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored.

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

impl<K: Into<IString>, V: Into<IValue>> Extend<(K, V)> for IObject

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K: Into<IString>, V: Into<IValue>> From<BTreeMap<K, V>> for IObject

fn from(other: BTreeMap<K, V>) -> Self

Performs the conversion.

impl<K: Into<IString>, V: Into<IValue>> From<HashMap<K, V, RandomState>> for IObject

fn from(other: HashMap<K, V>) -> Self

Performs the conversion.

impl From<IObject> for IValue

fn from(other: IObject) -> Self

Performs the conversion.

impl<K: Into<IString>, V: Into<IValue>> FromIterator<(K, V)> for IObject

fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for IObject

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<I: ObjectIndex> Index<I> for IObject

type Output = IValue

The returned type after indexing.

fn index(&self, index: I) -> &IValue

Performs the indexing (container[index]) operation.

impl<I: ObjectIndex> IndexMut<I> for IObject

fn index_mut(&mut self, index: I) -> &mut IValue

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

impl IntoIterator for IObject

type Item = (IString, IValue)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a IObject

type Item = (&'a IString, &'a IValue)

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut IObject

type Item = (&'a IString, &'a mut IValue)

The type of the elements being iterated over.

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<IObject> for IObject

fn eq(&self, other: &Self) -> 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 !=.

impl PartialOrd<IObject> for IObject

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for IObject

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

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a IValue> for &'a IObject

type Error = ()

The type returned in the event of a conversion error.

fn try_from(other: &'a IValue) -> Result<Self, ()>

Performs the conversion.

impl<'a> TryFrom<&'a mut IValue> for &'a mut IObject

type Error = ()

The type returned in the event of a conversion error.

fn try_from(other: &'a mut IValue) -> Result<Self, ()>

Performs the conversion.

impl TryFrom<IValue> for IObject

type Error = IValue

The type returned in the event of a conversion error.

fn try_from(other: IValue) -> Result<Self, IValue>

Performs the conversion.

impl Eq for IObject