Struct json_syntax::object::Object

source · [−]

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

Expand description

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 get<Q: ?Sized>(&self, key: &Q) -> Values<'_, M>ⓘNotable traits for Values<'a, M>`impl<'a, M> Iterator for Values<'a, M> type Item = &'a Meta<Value<M>, 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<Q: ?Sized>(&self, key: &Q) -> Entries<'_, M>ⓘNotable traits for Entries<'a, M>`impl<'a, M> Iterator for Entries<'a, M> type Item = &'a Entry<M>;` where
Q: Hash + Equivalent<Key>,

Returns an iterator over the entries matching the given key.

Runs in O(1) (average).

pub fn get_with_index<Q: ?Sized>(&self, key: &Q) -> ValuesWithIndex<'_, M>ⓘNotable traits for ValuesWithIndex<'a, M>`impl<'a, M> Iterator for ValuesWithIndex<'a, M> type Item = (usize, &'a Meta<Value<M>, 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>ⓘNotable traits for EntriesWithIndex<'a, M>`impl<'a, M> Iterator for EntriesWithIndex<'a, M> type Item = (usize, &'a Entry<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<'_>ⓘNotable traits for Indexes<'a>`impl<'a> Iterator for Indexes<'a> type Item = usize;` 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: Meta<Value<M>, 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: Meta<Value<M>, 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>ⓘNotable traits for RemovedEntries<'a, 'q, M, Q>`impl<'a, 'q, M, Q: ?Sized> Iterator for RemovedEntries<'a, 'q, M, Q> where     Q: Hash + Equivalent<Key>, type Item = Entry<M>;` where
    Q: Hash + Equivalent<Key>,

Remove all entries associated to the given 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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

impl<M> Default for Object<M>

fn default() -> Self

Returns the “default value” for a type. Read more

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

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

Extends a collection with the contents of an iterator. Read more

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. Read more

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. Read more

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. Read more

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>, Meta<Value<M>, M>)>>(
iter: I
) -> Self

Creates a value from an iterator. Read more

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. Read more

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

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,

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

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. Read more

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. Read more

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

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

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 ==. Read more

1.0.0 · source

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

This method tests for !=.

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

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>

Auto Trait Implementations

impl<M> RefUnwindSafe for Object<M> where
M: RefUnwindSafe,

impl<M> Send for Object<M> where
M: Send,

impl<M> Sync for Object<M> where
M: Sync,

impl<M> Unpin for Object<M> where
M: Unpin,

impl<M> UnwindSafe for Object<M> where
M: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> At for T

fn at<M>(self, metadata: M) -> Meta<T, M>

Wraps self inside a Meta<Self, M> using the given metadata. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> BorrowStripped for T

fn stripped(&self) -> &Stripped<T>

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.