Struct MappingAny 

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

A YAML mapping with Value keys.

Unlike Mapping which only supports String keys, MappingAny allows any Value as a key. This is useful for representing YAML mappings where keys might be numbers, booleans, or even nested structures.

Examples

use noyalib::{MappingAny, Value};

let mut map = MappingAny::new();
map.insert(Value::from(1), Value::from("one"));
map.insert(Value::from("two"), Value::from(2));
map.insert(Value::Bool(true), Value::from("yes"));

assert_eq!(map.len(), 3);
assert_eq!(map.get(&Value::from(1)).unwrap().as_str(), Some("one"));

YAML Example

This type can represent YAML like:

1: one
"two": 2
true: yes
[1, 2]: nested key

Implementations

impl MappingAny

pub fn new() -> Self

Creates an empty mapping.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty mapping with the specified capacity.

pub fn capacity(&self) -> usize

Returns the number of key-value pairs the mapping can hold without reallocating.

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

Reserves capacity for at least additional more key-value pairs.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the mapping as much as possible.

pub fn len(&self) -> usize

Returns the number of key-value pairs in the mapping.

pub fn is_empty(&self) -> bool

Returns true if the mapping contains no key-value pairs.

pub fn clear(&mut self)

Clears the mapping, removing all key-value pairs.

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

Inserts a key-value pair into the mapping.

If the mapping already had this key present, the value is updated, and the old value is returned.

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

Returns true if the mapping contains the specified key.

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

Returns a reference to the value corresponding to the key.

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

Returns a mutable reference to the value corresponding to the key.

pub fn get_index(&self, index: usize) -> Option<(&Value, &Value)>

Returns a reference to the key-value pair at the given index.

pub fn get_index_mut(&mut self, index: usize) -> Option<(&Value, &mut Value)>

Returns a mutable reference to the key-value pair at the given index.

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

Removes a key from the mapping, returning the value if the key was present.

This operation preserves the order of remaining elements.

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

Removes a key from the mapping, returning the key-value pair if present.

This operation preserves the order of remaining elements.

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

Removes a key by swapping it with the last element.

This is faster than remove but does not preserve order.

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

Removes a key by shifting all elements after it.

This preserves order but is slower than swap_remove.

pub fn entry(&mut self, key: Value) -> Entry<'_, Value, Value>

Gets the entry for the given key for in-place manipulation.

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&Value, &mut Value) -> bool,

Retains only the key-value pairs specified by the predicate.

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

Returns an iterator over the key-value pairs.

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

Returns a mutable iterator over the key-value pairs.

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

Returns an iterator over the keys.

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

Returns an iterator over the values.

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

Returns a mutable iterator over the values.

pub fn first(&self) -> Option<(&Value, &Value)>

Returns the first key-value pair.

pub fn first_mut(&mut self) -> Option<(&Value, &mut Value)>

Returns a mutable reference to the first key-value pair.

pub fn last(&self) -> Option<(&Value, &Value)>

Returns the last key-value pair.

pub fn last_mut(&mut self) -> Option<(&Value, &mut Value)>

Returns a mutable reference to the last key-value pair.

pub fn pop_first(&mut self) -> Option<(Value, Value)>

Removes and returns the first key-value pair.

pub fn pop_last(&mut self) -> Option<(Value, Value)>

Removes and returns the last key-value pair.

pub fn sort_keys(&mut self)

Sorts the mapping by keys.

pub fn reverse(&mut self)

Reverses the order of key-value pairs.

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

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

Extends the mapping with the contents of an iterator.

pub fn into_inner(self) -> IndexMap<Value, Value>

Returns the inner IndexMap.

pub fn from_inner(map: IndexMap<Value, Value>) -> Self

Creates a mapping from an IndexMap.

pub fn into_mapping(self) -> Option<Mapping>

Converts this MappingAny to a Mapping if all keys are strings.

Returns None if any key is not a string value.

Examples

use noyalib::{Mapping, MappingAny, Value};

let mut map = MappingAny::new();
map.insert(Value::from("key1"), Value::from(1));
map.insert(Value::from("key2"), Value::from(2));

let mapping = map.into_mapping().unwrap();
assert_eq!(mapping.len(), 2);

Trait Implementations

impl Clone for MappingAny

fn clone(&self) -> MappingAny

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MappingAny

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

Formats the value using the given formatter.

impl Default for MappingAny

fn default() -> MappingAny

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MappingAny

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MappingAny

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

Formats the value using the given formatter.

impl Eq for MappingAny

impl From<IndexMap<Value, Value, FxBuildHasher>> for MappingAny

fn from(map: IndexMap<Value, Value, FxBuildHasher>) -> Self

Converts to this type from the input type.

impl From<IndexMap<Value, Value>> for MappingAny

Available on crate feature std only.

fn from(map: IndexMap<Value, Value>) -> Self

Converts to this type from the input type.

impl From<Mapping> for MappingAny

fn from(map: Mapping) -> Self

Converts a Mapping (with String keys) into a MappingAny.

impl From<MappingAny> for IndexMap<Value, Value>

Available on crate feature std only.

fn from(map: MappingAny) -> Self

Converts to this type from the input type.

impl From<MappingAny> for IndexMap<Value, Value, FxBuildHasher>

fn from(map: MappingAny) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[(Value, Value); N]> for MappingAny

fn from(arr: [(Value, Value); N]) -> Self

Converts to this type from the input type.

impl FromIterator<(Value, Value)> for MappingAny

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

Creates a value from an iterator.

impl Hash for MappingAny

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 MappingAny

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

Index into the mapping by key.

Panics

Panics if the key is not present in the mapping.

type Output = Value

The returned type after indexing.

impl IndexMut<&Value> for MappingAny

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

Mutably index into the mapping by key.

Panics

Panics if the key is not present in the mapping.

impl IntoIterator for MappingAny

type Item = (Value, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter<Value, Value>

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 MappingAny

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

The type of the elements being iterated over.

type IntoIter = Iter<'a, Value, Value>

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 MappingAny

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

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Value, Value>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for MappingAny

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

impl PartialEq for MappingAny

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MappingAny

fn partial_cmp(&self, other: &Self) -> 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 MappingAny

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MappingAny

impl Value for MappingAny

fn stream<'sval, S: Stream<'sval> + ?Sized>( &'sval self, stream: &mut S, ) -> Result

Stream this value through a [Stream].

fn tag(&self) -> Option<Tag>

Get the tag of this value, if there is one.

fn to_bool(&self) -> Option<bool>

Try convert this value into a boolean.

fn to_f32(&self) -> Option<f32>

Try convert this value into a 32bit binary floating point number.

fn to_f64(&self) -> Option<f64>

Try convert this value into a 64bit binary floating point number.

fn to_i8(&self) -> Option<i8>

Try convert this value into a signed 8bit integer.

fn to_i16(&self) -> Option<i16>

Try convert this value into a signed 16bit integer.

fn to_i32(&self) -> Option<i32>

Try convert this value into a signed 32bit integer.

fn to_i64(&self) -> Option<i64>

Try convert this value into a signed 64bit integer.

fn to_i128(&self) -> Option<i128>

Try convert this value into a signed 128bit integer.

fn to_u8(&self) -> Option<u8>

Try convert this value into an unsigned 8bit integer.

fn to_u16(&self) -> Option<u16>

Try convert this value into an unsigned 16bit integer.

fn to_u32(&self) -> Option<u32>

Try convert this value into an unsigned 32bit integer.

fn to_u64(&self) -> Option<u64>

Try convert this value into an unsigned 64bit integer.

fn to_u128(&self) -> Option<u128>

Try convert this value into an unsigned 128bit integer.

fn to_text(&self) -> Option<&str>

Try convert this value into a text string.

fn to_binary(&self) -> Option<&[u8]>

Try convert this value into a bitstring.