Struct JsonObject 

pub struct JsonObject { /* private fields */ }

JSON object.

Comparison

The PartialEq and PartialOrd implementations will compare the JSON objects semantically, without regard for the entries indexes. The only exception is when one key has multiple values, in which cases the values are ordered by index. It is possible to compare the lexical representation of objects (where the entries indexes matter) by using the [BorrowJsonLexical::as_lexical] method on both ends and comparing the results.

Implementations

impl JsonObject

pub fn new() -> Self

pub fn from_vec(entries: Vec<(Key, JsonValue)>) -> Self

pub fn capacity(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn get_fragment(&self, index: usize) -> Result<JsonFragment<'_>, usize>

pub fn entries(&self) -> &[Entry]

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

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

pub fn iter_mapped<'m>( &self, code_map: &'m JsonCodeMap, offset: usize, ) -> IterMapped<'_, 'm>

pub fn into_iter_mapped<'m>( self, code_map: &'m JsonCodeMap, offset: usize, ) -> IntoIterMapped<'m>

pub fn iter_sorted(&self) -> IterSorted<'_>

pub fn iter_mut_sorted(&mut self) -> IterMutSorted<'_>

pub fn into_iter_sorted(self) -> IntoIterSorted

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

where Q: ?Sized + Comparable<Key>,

Checks if this object contains the given key.

Runs in O(log(n)) (average).

pub fn get<Q>(&self, key: &Q) -> Get<'_>

where Q: ?Sized + Comparable<Key>,

Returns an iterator over the values matching the given key.

Runs in O(log(n)) (average).

pub fn get_mut<Q>(&mut self, key: &Q) -> GetMut<'_>

where Q: ?Sized + Comparable<Key>,

Returns an iterator over the values matching the given key.

Runs in O(log(n)) (average).

pub fn get_unique<Q>( &self, key: &Q, ) -> Result<Option<&JsonValue>, DuplicateEntry<EntryRef<'_>>>

where Q: ?Sized + Comparable<Key>,

Returns the unique entry value matching the given key.

Returns an error if multiple entries match the key.

Runs in O(log(n)) (average).

pub fn get_unique_mut<Q>( &mut self, key: &Q, ) -> Result<Option<&mut JsonValue>, DuplicateEntry<EntryRef<'_>>>

where Q: ?Sized + Comparable<Key>,

Returns the unique entry value matching the given key.

Returns an error if multiple entries match the key.

Runs in O(log(n)) (average).

pub fn get_entries<Q>(&self, key: &Q) -> GetEntries<'_>

where Q: ?Sized + Comparable<Key>,

Returns an iterator over the entries matching the given key.

Runs in O(log(n)) (average).

pub fn get_unique_entry<Q>( &self, key: &Q, ) -> Result<Option<EntryRef<'_>>, DuplicateEntry<EntryRef<'_>>>

where Q: ?Sized + Comparable<Key>,

Returns the unique entry matching the given key.

Returns an error if multiple entries match the key.

Runs in O(log(n)) (average).

pub fn get_indexed<Q>(&self, key: &Q) -> GetIndexed<'_>

where Q: ?Sized + Comparable<Key>,

Returns an iterator over the values matching the given key.

Runs in O(log(n)) (average).

pub fn get_indexed_entries<Q>(&self, key: &Q) -> GetIndexedEntries<'_>

where Q: ?Sized + Comparable<Key>,

Returns an iterator over the entries matching the given key.

Runs in O(log(n)) (average).

pub fn get_or_insert_with<Q>( &mut self, key: impl Into<Key>, f: impl FnOnce() -> JsonValue, ) -> Get<'_>

Returns the (first) value associated to key, or insert a key-value entry where value is returned by the given function f.

pub fn get_or_insert_mut_with<Q>( &mut self, key: impl Into<Key>, f: impl FnOnce() -> JsonValue, ) -> GetMut<'_>

Returns a mutable reference to the (first) value associated to key, or insert a key-value entry where value is returned by the given function f.

pub fn index_of<Q>(&self, key: &Q) -> Option<usize>

where Q: ?Sized + Comparable<Key>,

pub fn indexes_of<Q>(&self, key: &Q) -> IndexesIter<'_>

where Q: ?Sized + Comparable<Key>,

pub fn redundant_index_of<Q>(&self, key: &Q) -> Option<usize>

where Q: ?Sized + Comparable<Key>,

pub fn get_mapped_entries<'m, Q>( &self, code_map: &'m JsonCodeMap, offset: usize, key: &Q, ) -> GetMappedEntries<'_, 'm>

where Q: ?Sized + Comparable<Key>,

Returns an iterator over the mapped entries matching the given key.

Runs in O(n) (average). O(log(n)) to find the entry, O(n) to compute the entry fragment offset.

pub fn get_unique_mapped_entry<Q>( &self, code_map: &JsonCodeMap, offset: usize, key: &Q, ) -> Result<Option<MappedEntryRef<'_>>, DuplicateEntry<MappedEntryRef<'_>>>

where Q: ?Sized + Comparable<Key>,

Returns the unique mapped entry matching the given key.

Runs in O(n) (average). O(1) to find the entry, O(n) to compute the entry fragment offset.

pub fn get_mapped_entries_with_index<'m, Q>( &self, code_map: &'m JsonCodeMap, offset: usize, key: &Q, ) -> GetIndexedMappedEntries<'_, 'm>

where Q: ?Sized + Comparable<Key>,

Returns an iterator over the mapped entries matching the given key, with their index.

Runs in O(n) (average). O(1) to find the entry, O(n) to compute the entry fragment offset.

pub fn get_unique_mapped_entry_with_index<Q>( &self, code_map: &JsonCodeMap, offset: usize, key: &Q, ) -> Result<Option<IndexedMappedEntry<'_>>, DuplicateEntry<IndexedMappedEntry<'_>>>

where Q: ?Sized + Comparable<Key>,

Returns the unique mapped entry matching the given key, with its index.

Runs in O(n) (average). O(1) to find the entry, O(n) to compute the entry fragment offset.

pub fn get_mapped<'m, Q>( &self, code_map: &'m JsonCodeMap, offset: usize, key: &Q, ) -> GetMapped<'_, 'm>

where Q: ?Sized + Comparable<Key>,

Returns an iterator over the mapped values matching the given key.

Runs in O(n) (average). O(1) to find the entry, O(n) to compute the entry fragment offset.

pub fn get_unique_mapped<Q>( &self, code_map: &JsonCodeMap, offset: usize, key: &Q, ) -> Result<Option<JsonMapped<&JsonValue>>, DuplicateEntry<JsonMapped<&JsonValue>>>

where Q: ?Sized + Comparable<Key>,

Returns the unique mapped values matching the given key.

Runs in O(n) (average). O(1) to find the entry, O(n) to compute the entry fragment offset.

pub fn get_indexed_mapped<'m, Q>( &self, code_map: &'m JsonCodeMap, offset: usize, key: &Q, ) -> GetIndexedMapped<'_, 'm>

where Q: ?Sized + Comparable<Key>,

Returns an iterator over the mapped values matching the given key, with their index.

Runs in O(n) (average). O(1) to find the entry, O(n) to compute the entry fragment offset.

pub fn get_unique_mapped_with_index<Q>( &self, code_map: &JsonCodeMap, offset: usize, key: &Q, ) -> Result<Option<IndexedMappedValue<'_>>, DuplicateEntry<IndexedMappedValue<'_>>>

where Q: ?Sized + Comparable<Key>,

Returns the unique mapped values matching the given key, with its index.

Runs in O(n) (average). O(1) to find the entry, O(n) to compute the entry fragment offset.

pub fn first(&self) -> Option<EntryRef<'_>>

pub fn last(&self) -> Option<EntryRef<'_>>

pub fn push_back( &mut self, key: impl Into<Key>, value: JsonValue, ) -> (usize, bool)

Push the given key-value pair to the end of the object.

Returns true if the key was not already present in the object, and false otherwise. Any previous entry matching the key is not overridden: duplicates are preserved, in order.

Runs in O(1).

pub fn push_entry_back(&mut self, (key, value): Entry) -> (usize, bool)

pub fn push_front(&mut self, key: impl Into<Key>, value: JsonValue) -> bool

Push the given key-value pair to the top of the object.

Returns true if the key was not already present in the object, and false otherwise. Any previous entry matching the key is not overridden: duplicates are preserved, in order.

Runs in O(n).

pub fn push_entry_front(&mut self, (key, value): Entry) -> bool

pub fn swap_remove_at(&mut self, i: usize) -> Option<Entry>

Removes the entry at the given index i.

pub fn shift_remove_at(&mut self, i: usize) -> Option<Entry>

Removes the entry at the given index i.

pub fn shift_insert( &mut self, key: impl Into<Key>, value: JsonValue, ) -> ShiftInsert<'_>

Inserts the given key-value pair.

If one or more entries are already matching the given key, all of them are removed and returned in the resulting iterator. Otherwise, None is returned.

pub fn swap_insert( &mut self, key: impl Into<Key>, value: JsonValue, ) -> SwapInsert<'_>

pub fn shift_insert_front( &mut self, key: impl Into<Key>, value: JsonValue, ) -> ShiftInsertFront<'_>

Inserts the given key-value pair on top of the object.

If one or more entries are already matching the given key, all of them are removed and returned in the resulting iterator.

pub fn swap_insert_front( &mut self, key: impl Into<Key>, value: JsonValue, ) -> SwapInsertFront<'_>

pub fn shift_insert_back_full( &mut self, key: impl Into<Key>, value: JsonValue, ) -> (usize, ShiftInsertBack<'_>)

pub fn shift_insert_back( &mut self, key: impl Into<Key>, value: JsonValue, ) -> ShiftInsertBack<'_>

pub fn insert( &mut self, key: impl Into<Key>, value: JsonValue, ) -> ShiftInsertBack<'_>

Alias of Self::shift_insert_back.

pub fn swap_insert_back_full( &mut self, key: impl Into<Key>, value: JsonValue, ) -> (usize, SwapInsertBack<'_>)

pub fn swap_insert_back( &mut self, key: impl Into<Key>, value: JsonValue, ) -> SwapInsertBack<'_>

pub fn shift_remove_indexed_entries<Q>( &mut self, key: &Q, ) -> ShiftRemoveIndexedEntries<'_>

where Q: ?Sized + Comparable<Key>,

pub fn shift_remove_entries<Q>(&mut self, key: &Q) -> ShiftRemoveEntries<'_>

where Q: ?Sized + Comparable<Key>,

Remove all entries associated to the given key.

pub fn shift_remove<Q>(&mut self, key: &Q) -> ShiftRemove<'_>

where Q: ?Sized + Comparable<Key>,

Remove all entries associated to the given key.

pub fn remove<Q>(&mut self, key: &Q) -> ShiftRemove<'_>

where Q: ?Sized + Comparable<Key>,

Alias of Self::shift_remove.

pub fn remove_unique<Q>( &mut self, key: &Q, ) -> Result<Option<Entry>, DuplicateEntry<Entry>>

where Q: ?Sized + Comparable<Key>,

Alias of Self::shift_remove_unique.

pub fn swap_remove_indexed_entries<Q>( &mut self, key: &Q, ) -> SwapRemoveIndexedEntries<'_>

where Q: ?Sized + Comparable<Key>,

pub fn swap_remove_entries<Q>(&mut self, key: &Q) -> SwapRemoveEntries<'_>

where Q: ?Sized + Comparable<Key>,

pub fn swap_remove<Q>(&mut self, key: &Q) -> SwapRemove<'_>

where Q: ?Sized + Comparable<Key>,

pub fn swap_remove_unique<Q>( &mut self, key: &Q, ) -> Result<Option<Entry>, DuplicateEntry<Entry>>

where Q: ?Sized + Comparable<Key>,

Remove the unique entry associated to the given key.

Returns an error if multiple entries match the key.

pub fn shift_remove_unique<Q>( &mut self, key: &Q, ) -> Result<Option<Entry>, DuplicateEntry<Entry>>

where Q: ?Sized + Comparable<Key>,

Remove the unique entry associated to the given key.

Returns an error if multiple entries match the key.

pub fn sort(&mut self)

Sort the entries by key name.

The relative order of entries with the same key is unchanged.

pub fn canonicalize_with(&mut self, buffer: &mut Buffer)

Puts this JSON object in canonical form according to RFC 8785.

This will canonicalize the entries and sort them by key. The relative order of entries with the same key is unchanged.

pub fn canonicalize(&mut self)

Puts this JSON object in canonical form according to RFC 8785.

Trait Implementations

impl Clone for JsonObject

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonObject

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

Formats the value using the given formatter.

impl Default for JsonObject

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonObject

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for JsonObject

impl Extend<(SmallString<[u8; 16]>, JsonValue)> for JsonObject

fn extend<I: IntoIterator<Item = Entry>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

🔬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 From<JsonObject> for JsonValue

fn from(o: JsonObject) -> Self

Converts to this type from the input type.

impl From<Vec<(SmallString<[u8; 16]>, JsonValue)>> for JsonObject

fn from(entries: Vec<Entry>) -> Self

Converts to this type from the input type.

impl FromIterator<(SmallString<[u8; 16]>, JsonValue)> for JsonObject

fn from_iter<I: IntoIterator<Item = Entry>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for JsonObject

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'de> IntoDeserializer<'de, DeserializeError> for JsonObject

type Deserializer = JsonValue

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl<'a> IntoIterator for &'a JsonObject

type Item = (&'a SmallString<[u8; 16]>, &'a JsonValue)

The type of the elements being iterated over.

type IntoIter = Iter<'a, SmallString<[u8; 16]>, JsonValue>

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 JsonObject

type Item = (&'a SmallString<[u8; 16]>, &'a mut JsonValue)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, SmallString<[u8; 16]>, JsonValue>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for JsonObject

type Item = (SmallString<[u8; 16]>, JsonValue)

The type of the elements being iterated over.

type IntoIter = IntoIter<(SmallString<[u8; 16]>, JsonValue)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl JsonBorrowLexical for JsonObject

fn as_lexical(&self) -> &JsonLexical<Self>

impl JsonLexicalEq for JsonObject

impl JsonLexicalHash for JsonObject

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

impl JsonLexicalPartialEq for JsonObject

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

impl JsonVisit for JsonObject

fn visit<V: JsonVisitor>(&self, visitor: V) -> V::Output

impl Ord for JsonObject

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for JsonObject

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for JsonObject

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for JsonObject

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for JsonObject