Struct json_syntax::object::Object

pub struct Object<M> { /* private fields */ }

Object.

Implementations

impl<M> Object<M>

pub fn new() -> Self

pub fn from_vec(entries: Vec<Entry<M>>) -> Self

pub fn capacity(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

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

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

pub fn get<Q: ?Sized>(&self, key: &Q) -> Values<'_, M>where
    Q: Hash + Equivalent<Key>,

Returns an iterator over the values matching the given key.

Runs in O(1) (average).

pub fn get_mut<Q: ?Sized>(&mut self, key: &Q) -> ValuesMut<'_, M>where
    Q: Hash + Equivalent<Key>,

Returns an iterator over the values matching the given key.

Runs in O(1) (average).

pub fn get_unique<Q: ?Sized>(
    &self,
    key: &Q
) -> Result<Option<&MetaValue<M>>, Duplicate<&Entry<M>>>where
    Q: Hash + Equivalent<Key>,

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: ?Sized>(
    &mut self,
    key: &Q
) -> Result<Option<&mut MetaValue<M>>, Duplicate<&Entry<M>>>where
    Q: Hash + Equivalent<Key>,

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: ?Sized>(&self, key: &Q) -> Entries<'_, M>where
    Q: Hash + Equivalent<Key>,

Returns an iterator over the entries matching the given key.

Runs in O(1) (average).

pub fn get_unique_entry<Q: ?Sized>(
    &self,
    key: &Q
) -> Result<Option<&Entry<M>>, Duplicate<&Entry<M>>>where
    Q: Hash + Equivalent<Key>,

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: ?Sized>(&self, key: &Q) -> ValuesWithIndex<'_, M>where
    Q: Hash + Equivalent<Key>,

Returns an iterator over the entries matching the given key.

Runs in O(1) (average).

pub fn get_entries_with_index<Q: ?Sized>(
    &self,
    key: &Q
) -> EntriesWithIndex<'_, M>where
    Q: Hash + Equivalent<Key>,

Returns an iterator over the entries matching the given key.

Runs in O(1) (average).

pub fn index_of<Q: ?Sized>(&self, key: &Q) -> Option<usize>where
    Q: Hash + Equivalent<Key>,

pub fn redundant_index_of<Q: ?Sized>(&self, key: &Q) -> Option<usize>where
    Q: Hash + Equivalent<Key>,

pub fn indexes_of<Q: ?Sized>(&self, key: &Q) -> Indexes<'_>where
    Q: Hash + Equivalent<Key>,

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

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

pub fn push(&mut self, key: Meta<Key, M>, value: MetaValue<M>) -> 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<M>) -> bool

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

Removes the entry at the given index.

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

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 remove<'q, Q: ?Sized>(
    &mut self,
    key: &'q Q
) -> RemovedEntries<'_, 'q, M, Q>where
    Q: Hash + Equivalent<Key>,

Remove all entries associated to the given key.

Runs in O(n) time (average).

pub fn remove_unique<Q: ?Sized>(
    &mut self,
    key: &Q
) -> Result<Option<Entry<M>>, Duplicate<Entry<M>>>where
    Q: Hash + Equivalent<Key>,

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 map_metadata<N>(self, f: impl FnMut(M) -> N) -> Object<N>

Recursively maps the metadata inside the object.

pub fn try_map_metadata<N, E>(
    self,
    f: impl FnMut(M) -> Result<N, E>
) -> Result<Object<N>, E>

Tries to recursively maps the metadata inside the object.

Trait Implementations

impl<M: Clone> Clone for Object<M>

fn clone(&self) -> Object<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for Object<M>

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

Formats the value using the given formatter.

impl<M> Default for Object<M>

fn default() -> Self

Returns the “default value” for a type.

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

fn extend<I: IntoIterator<Item = (Meta<Key, M>, MetaValue<M>)>>(
    &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<M> Extend<Entry<M>> for Object<M>

fn extend<I: IntoIterator<Item = Entry<M>>>(&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<M> From<Object<M>> for Value<M>

fn from(o: Object<M>) -> Self

Converts to this type from the input type.

impl<M> From<Vec<Entry<M>, Global>> for Object<M>

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

Converts to this type from the input type.

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

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

Creates a value from an iterator.

impl<M> FromIterator<Entry<M>> for Object<M>

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

Creates a value from an iterator.

impl<M: Hash> Hash for Object<M>

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

type Item = &'a Entry<M>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Entry<M>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<M> IntoIterator for Object<M>

type Item = Entry<M>

The type of the elements being iterated over.

type IntoIter = IntoIter<Entry<M>, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<M: Ord> Ord for Object<M>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<M: PartialEq> PartialEq<Object<M>> for Object<M>

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<M: PartialOrd> PartialOrd<Object<M>> for Object<M>

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

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

impl<M> StrippedHash for Object<M>

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

impl<M> StrippedOrd for Object<M>

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

impl<M> StrippedPartialEq<Object<M>> for Object<M>

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

impl<M> StrippedPartialOrd<Object<M>> for Object<M>

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

impl<M: Eq> Eq for Object<M>

impl<M> StrippedEq for Object<M>