Struct Object 

pub struct Object { /* private fields */ }

Object.

Implementations

impl Object

pub fn new() -> Object

Creates a new empty object.

pub fn with_capacity(capacity: usize) -> Object

Creates a new empty object with room for capacity entries.

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

Builds an object from a list of entries, keeping their order and any duplicate keys.

pub const fn capacity(&self) -> usize

Returns the number of entries this object can hold without reallocating.

pub const fn len(&self) -> usize

Returns the number of entries in this object, duplicates included.

pub const fn is_empty(&self) -> bool

Checks if this object has no entries.

pub fn contains_duplicate_keys(&self) -> bool

Whether two entries of this object share a key.

Runs in O(n) over the key index; the object’s descendants are not inspected.

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

Returns the fragment at the given index, relative to the contents of this object: index 0 is the first entry.

On failure, returns the number of fragments left to skip.

Errors

Returns the number of fragments left to skip when index does not resolve to a fragment within this object.

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

Returns the entries of this object as a slice, in definition order.

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

Iterates over the entries of this object, in definition order.

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

Iterates over the entries of this object, yielding mutable values.

Keys are not mutable: changing one would invalidate the key index.

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

Iterates over the entries of this object, pairing each entry, key and value with its offset in code_map.

offset is the code map offset of the object itself.

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

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

Checks if this object contains the given key.

Runs in O(1) (average).

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

where Q: Hash + Equivalent<CompactString> + ?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<CompactString> + ?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<CompactString> + ?Sized,

Returns the unique entry value matching the given key.

Returns an error if multiple entries match the key.

Runs in O(1) (average).

Errors

Returns Duplicate if more than one entry matches key.

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

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

Returns the unique entry value matching the given key.

Returns an error if multiple entries match the key.

Runs in O(1) (average).

Errors

Returns Duplicate if more than one entry matches key.

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

where Q: Hash + Equivalent<CompactString> + ?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<CompactString> + ?Sized,

Returns the unique entry matching the given key.

Returns an error if multiple entries match the key.

Runs in O(1) (average).

Errors

Returns Duplicate if more than one entry matches key.

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

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

Returns an iterator over the values matching the given key.

Runs in O(1) (average).

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

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

Returns an iterator over the entries matching the given key.

Runs in O(1) (average).

pub fn get_or_insert_with<Q>( &mut self, key: &Q, f: impl FnOnce() -> Value, ) -> &Value

where Q: Hash + Equivalent<CompactString> + ToOwned + ?Sized, <Q as ToOwned>::Owned: Into<CompactString>,

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_mut_or_insert_with<Q>( &mut self, key: &Q, f: impl FnOnce() -> Value, ) -> &mut Value

where Q: Hash + Equivalent<CompactString> + ToOwned + ?Sized, <Q as ToOwned>::Owned: Into<CompactString>,

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: Hash + Equivalent<CompactString> + ?Sized,

Returns the position of the first entry matching key.

Runs in O(1) (average).

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

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

Returns the position of the second entry matching key, if the key is duplicated.

Runs in O(1) (average).

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

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

Iterates over the positions of every entry matching key.

Runs in O(1) (average).

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

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

Returns an iterator over the mapped entries 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_entry<Q>( &self, code_map: &CodeMap, offset: usize, key: &Q, ) -> Result<Option<Mapped<Entry<Mapped<&CompactString>, Mapped<&Value>>>>, Duplicate<Mapped<Entry<Mapped<&CompactString>, Mapped<&Value>>>>>

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

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.

Errors

Returns Duplicate if more than one entry matches key.

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

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

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: &CodeMap, offset: usize, key: &Q, ) -> Result<Option<(usize, Mapped<Entry<Mapped<&CompactString>, Mapped<&Value>>>)>, Duplicate<(usize, Mapped<Entry<Mapped<&CompactString>, Mapped<&Value>>>)>>

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

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.

Errors

Returns Duplicate if more than one entry matches key.

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

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

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: &CodeMap, offset: usize, key: &Q, ) -> Result<Option<Mapped<&Value>>, Duplicate<Mapped<&Value>>>

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

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.

Errors

Returns Duplicate if more than one entry matches key.

pub fn get_mapped_with_index<'m, Q>( &self, code_map: &'m CodeMap, offset: usize, key: &Q, ) -> MappedValuesWithIndex<'_, 'm>

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

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: &CodeMap, offset: usize, key: &Q, ) -> Result<Option<(usize, Mapped<&Value>)>, Duplicate<(usize, Mapped<&Value>)>>

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

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.

Errors

Returns Duplicate if more than one entry matches key.

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

Returns the first entry of this object.

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

Returns the last entry of this object.

pub fn push(&mut self, key: CompactString, 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

Push the given entry to the end of the object.

Returns true if its key was not already present in the object.

Runs in O(1).

pub fn push_front(&mut self, key: CompactString, 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

Push the given entry to the top of the object.

Returns true if its key was not already present in the object.

Runs in O(n).

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

Removes the entry at the given index.

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

where Q: Hash + Equivalent<CompactString> + ?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<CompactString> + ?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).

Errors

Returns Duplicate if more than one entry matches key.

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 duplicate 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<(), Error>

Formats the value using the given formatter.

impl Default for Object

fn default() -> Object

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Object

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for Object

fn drop(&mut self)

Drops the entries without recursing: every nested container is moved onto a heap worklist and emptied there before it drops, so each drop only ever sees empty children. An object holding no nested container allocates nothing.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for Object

impl Extend<(CompactString, Value)> for Object

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = (CompactString, Value)>,

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

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = Entry>,

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

fn from(o: Object) -> Value

Converts to this type from the input type.

impl From<Vec<Entry>> for Object

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

Converts to this type from the input type.

impl FromIterator<(CompactString, Value)> for Object

fn from_iter<I>(iter: I) -> Object

where I: IntoIterator<Item = (CompactString, Value)>,

Creates a value from an iterator.

impl FromIterator<Entry> for Object

fn from_iter<I>(iter: I) -> Object

where I: IntoIterator<Item = Entry>,

Creates a value from an iterator.

impl Hash for Object

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

where H: Hasher,

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 IntoDeserializer<'_, DeserializeError> for Object

type Deserializer = Value

The type of the deserializer being converted into.

fn into_deserializer( self, ) -> <Object as IntoDeserializer<'_, DeserializeError>>::Deserializer

Convert this value into a deserializer.

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) -> <&'a Object as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = (&'a CompactString, &'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) -> <&'a mut Object as IntoIterator>::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) -> <Object as IntoIterator>::IntoIter

Creates an iterator from a value.

impl Ord for Object

fn cmp(&self, other: &Object) -> 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 Object

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Object

fn partial_cmp(&self, other: &Object) -> 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 PrintWithSize for Object

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

Writes the value to f, taking its layout from sizes[*index].

impl Serialize for Object

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl UnorderedEq for Object

impl UnorderedPartialEq for Object

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

Checks if self and other are equal modulo object entry order.