Struct VObject 

pub struct VObject(/* private fields */);

An object (map) value.

VObject is an ordered map of string keys to Values. It preserves insertion order.

Storage modes:

• Small mode (default): inline array of KeyValuePair with linear search
• Large mode (std feature, >= 32 entries): IndexMap for O(1) lookups

Implementations

impl VObject

pub fn new() -> Self

Creates a new empty object.

pub fn with_capacity(cap: usize) -> Self

Creates a new object with the specified capacity.

pub fn len(&self) -> usize

Returns the number of entries.

pub fn is_empty(&self) -> bool

Returns true if the object is empty.

pub fn capacity(&self) -> usize

Returns the capacity.

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more entries.

pub fn get(&self, key: &str) -> Option<&Value>

Gets a value by key.

pub fn get_mut(&mut self, key: &str) -> Option<&mut Value>

Gets a mutable value by key.

pub fn get_key_value(&self, key: &str) -> Option<(&VString, &Value)>

Gets a key-value pair by key.

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

Returns true if the object contains the key.

pub fn insert( &mut self, key: impl Into<VString>, value: impl Into<Value>, ) -> Option<Value>

Inserts a key-value pair. Returns the old value if the key existed.

pub fn remove(&mut self, key: &str) -> Option<Value>

Removes a key-value pair. Returns the value if the key existed.

pub fn remove_entry(&mut self, key: &str) -> Option<(VString, Value)>

Removes and returns a key-value pair.

pub fn clear(&mut self)

Clears the object.

pub fn keys(&self) -> Keys<'_>

Returns an iterator over keys.

pub fn values(&self) -> Values<'_>

Returns an iterator over values.

pub fn values_mut(&mut self) -> ValuesMut<'_>

Returns an iterator over mutable values.

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

Returns an iterator over key-value pairs.

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

Returns an iterator over mutable key-value pairs.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity to match the length.

impl VObject

pub fn into_value(self) -> Value

Converts this VObject into a Value, consuming self.

Trait Implementations

impl AsMut<Value> for VObject

fn as_mut(&mut self) -> &mut Value

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Value> for VObject

fn as_ref(&self) -> &Value

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for VObject

fn clone(&self) -> VObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VObject

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

Formats the value using the given formatter.

impl Default for VObject

fn default() -> Self

Returns the “default value” for a type.

impl<K: Into<VString>, V: Into<Value>> Extend<(K, V)> for VObject

Available on crate feature alloc only.

fn extend<I: IntoIterator<Item = (K, V)>>(&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<K: Into<VString>, V: Into<Value>> From<BTreeMap<K, V>> for VObject

Available on crate feature alloc only.

fn from(map: BTreeMap<K, V>) -> Self

Converts to this type from the input type.

impl<K: Into<VString>, V: Into<Value>> From<HashMap<K, V>> for VObject

Available on crate feature std only.

fn from(map: HashMap<K, V>) -> Self

Converts to this type from the input type.

impl From<VObject> for Value

fn from(obj: VObject) -> Self

Converts to this type from the input type.

impl<K: Into<VString>, V: Into<Value>> FromIterator<(K, V)> for VObject

Available on crate feature alloc only.

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for VObject

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 Index<&str> for VObject

type Output = Value

The returned type after indexing.

fn index(&self, key: &str) -> &Value

Performs the indexing (container[index]) operation.

impl IndexMut<&str> for VObject

fn index_mut(&mut self, key: &str) -> &mut Value

Performs the mutable indexing (container[index]) operation.

impl<'a> IntoIterator for &'a VObject

type Item = (&'a VString, &'a Value)

The type of the elements being iterated over.

type IntoIter = Iter<'a>

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 VObject

type Item = (&'a VString, &'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 VObject

type Item = (VString, Value)

The type of the elements being iterated over.

type IntoIter = ObjectIntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for VObject

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for VObject