Struct json_syntax::object::Object

pub struct Object { /* private fields */ }

Object.

Implementations

impl Object

pub fn new() -> Self

pub fn from_vec(entries: Vec<Entry>) -> 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<FragmentRef<'_>, usize>

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

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

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

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

where Q: Hash + Equivalent<Key> + ?Sized,

Returns an iterator over the values matching the given key.

Runs in O(1) (average).

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

where Q: Hash + Equivalent<Key> + ?Sized,

Returns an iterator over the values matching the given key.

Runs in O(1) (average).

pub fn get_unique<Q>( &self, key: &Q ) -> Result<Option<&Value>, Duplicate<&Entry>>

where Q: Hash + Equivalent<Key> + ?Sized,

Returns the unique entry value matching the given key.

Returns an error if multiple entries match the key.

Runs in O(1) (average).

pub fn get_unique_mut<Q>( &mut self, key: &Q ) -> Result<Option<&mut Value>, Duplicate<&Entry>>

where Q: Hash + Equivalent<Key> + ?Sized,

Returns the unique entry value matching the given key.

Returns an error if multiple entries match the key.

Runs in O(1) (average).

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

where Q: Hash + Equivalent<Key> + ?Sized,

Returns an iterator over the entries matching the given key.

Runs in O(1) (average).

pub fn get_unique_entry<Q>( &self, key: &Q ) -> Result<Option<&Entry>, Duplicate<&Entry>>

where Q: Hash + Equivalent<Key> + ?Sized,

Returns the unique entry matching the given key.

Returns an error if multiple entries match the key.

Runs in O(1) (average).

pub fn get_with_index<Q>(&self, key: &Q) -> ValuesWithIndex<'_>

where Q: Hash + Equivalent<Key> + ?Sized,

Returns an iterator over the entries matching the given key.

Runs in O(1) (average).

pub fn get_entries_with_index<Q>(&self, key: &Q) -> EntriesWithIndex<'_>

where Q: Hash + Equivalent<Key> + ?Sized,

Returns an iterator over the entries matching the given key.

Runs in O(1) (average).

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

where Q: Hash + Equivalent<Key> + ?Sized,

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

where Q: Hash + Equivalent<Key> + ?Sized,

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

where Q: Hash + Equivalent<Key> + ?Sized,

pub fn first(&self) -> Option<&Entry>

pub fn last(&self) -> Option<&Entry>

pub fn push(&mut self, key: Key, value: Value) -> 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(&mut self, entry: Entry) -> bool

pub fn push_front(&mut self, key: Key, value: Value) -> 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, entry: Entry) -> bool

pub fn remove_at(&mut self, index: usize) -> Option<Entry>

Removes the entry at the given index.

pub fn insert( &mut self, key: Key, value: Value ) -> Option<RemovedByInsertion<'_>>

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 insert_front( &mut self, key: Key, value: Value ) -> RemovedByInsertFront<'_>

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 remove<'q, Q>(&mut self, key: &'q Q) -> RemovedEntries<'_, 'q, Q>

where Q: Hash + Equivalent<Key> + ?Sized,

Remove all entries associated to the given key.

Runs in O(n) time (average).

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

where Q: Hash + Equivalent<Key> + ?Sized,

Remove the unique entry associated to the given key.

Returns an error if multiple entries match the key.

Runs in O(n) time (average).

pub fn sort(&mut self)

Sort the entries by key name.

Entries with the same key are sorted by value.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Object

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.

impl Default for Object

fn default() -> Self

Returns the “default value” for a type.

impl Extend<(SmallString<[u8; 16]>, Value)> for Object

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

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 Extend<Entry> for Object

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: 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 From<Object> for Value

fn from(o: Object) -> Self

Converts to this type from the input type.

impl From<Vec<Entry>> for Object

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

Converts to this type from the input type.

impl FromIterator<(SmallString<[u8; 16]>, Value)> for Object

fn from_iter<I: IntoIterator<Item = (Key, Value)>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<Entry> for Object

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

Creates a value from an iterator.

impl Hash for Object

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<'a> IntoIterator for &'a Object

type Item = &'a Entry

The type of the elements being iterated over.

type IntoIter = Iter<'a, Entry>

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 Object

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

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 IntoIterator for Object

type Item = Entry

The type of the elements being iterated over.

type IntoIter = IntoIter<Entry>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Object

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Object

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Object

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 PrintWithSize for Object

fn fmt_with_size( &self, f: &mut Formatter<'_>, options: &Options, indent: usize, sizes: &[Size], index: &mut usize ) -> Result

impl UnorderedPartialEq for Object

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

impl Eq for Object

impl UnorderedEq for Object