Struct ron::value::Map

source ·
pub struct Map(/* private fields */);
Expand description

A Value to Value map.

This structure either uses a BTreeMap or the IndexMap internally. The latter can be used by enabling the indexmap feature. This can be used to preserve the order of the parsed map.

Implementations§

source§

impl Map

source

pub fn new() -> Map

Creates a new, empty Map.

source

pub fn len(&self) -> usize

Returns the number of elements in the map.

source

pub fn is_empty(&self) -> bool

Returns true if self.len() == 0, false otherwise.

source

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

Inserts a new element, returning the previous element with this key if there was any.

source

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

Removes an element by its key.

source

pub fn iter( &self ) -> impl Iterator<Item = (&Value, &Value)> + DoubleEndedIterator

Iterate all key-value pairs.

source

pub fn iter_mut( &mut self ) -> impl Iterator<Item = (&Value, &mut Value)> + DoubleEndedIterator

Iterate all key-value pairs mutably.

source

pub fn keys(&self) -> impl Iterator<Item = &Value> + DoubleEndedIterator

Iterate all keys.

source

pub fn values(&self) -> impl Iterator<Item = &Value> + DoubleEndedIterator

Iterate all values.

source

pub fn values_mut( &mut self ) -> impl Iterator<Item = &mut Value> + DoubleEndedIterator

Iterate all values mutably.

source

pub fn retain<F>(&mut self, keep: F)
where F: FnMut(&Value, &mut Value) -> bool,

Retains only the elements specified by the keep predicate.

In other words, remove all pairs (k, v) for which keep(&k, &mut v) returns false.

The elements are visited in iteration order.

Trait Implementations§

source§

impl Clone for Map

source§

fn clone(&self) -> Map

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
source§

impl Debug for Map

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Map

source§

fn default() -> Map

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

impl<'de> Deserialize<'de> for Map

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl FromIterator<(Value, Value)> for Map

source§

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

Creates a value from an iterator. Read more
source§

impl Hash for Map

source§

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, Self: Sized,

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

impl Index<&Value> for Map

§

type Output = Value

The returned type after indexing.
source§

fn index(&self, index: &Value) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
source§

impl IndexMut<&Value> for Map

source§

fn index_mut(&mut self, index: &Value) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
source§

impl IntoIterator for Map

§

type Item = (Value, Value)

The type of the elements being iterated over.
§

type IntoIter = <BTreeMap<Value, Value> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl Ord for Map

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Map

Note: equality is only given if both values and order of values match

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

impl PartialOrd for Map

source§

fn partial_cmp(&self, other: &Map) -> 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
source§

impl Serialize for Map

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for Map

Note: equality is only given if both values and order of values match

Auto Trait Implementations§

§

impl Freeze for Map

§

impl RefUnwindSafe for Map

§

impl Send for Map

§

impl Sync for Map

§

impl Unpin for Map

§

impl UnwindSafe for Map

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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.

source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

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

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,