Struct ron::value::Map

pub struct Map(BTreeMap<Value, Value>);

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.

Tuple Fields

0: BTreeMap<Value, Value>

Implementations

impl Map

pub fn new() -> Map

Creates a new, empty Map.

pub fn len(&self) -> usize

Returns the number of elements in the map.

pub fn is_empty(&self) -> bool

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

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.

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

Removes an element by its key.

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

Iterate all key-value pairs.

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

Iterate all key-value pairs mutably.

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

Iterate all keys.

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

Iterate all values.

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

Iterate all values mutably.

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

impl Clone for Map

fn clone(&self) -> Map

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Map

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

Formats the value using the given formatter.

impl Default for Map

fn default() -> Map

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromIterator<(Value, Value)> for Map

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

Creates a value from an iterator.

impl Hash for Map

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<&Value> for Map

type Output = Value

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<&Value> for Map

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

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

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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Map

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

Restrict a value to a certain interval.

impl PartialEq for Map

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

fn eq(&self, other: &Map) -> 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 PartialOrd for Map

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Map

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