Struct Mapping 

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

A YAML mapping (dictionary/object).

This is an ordered map that preserves insertion order, wrapping IndexMap<String, Value>. It provides a comprehensive API for working with YAML mappings.

Examples

use noyalib::{Mapping, Value};

let mut map = Mapping::new();
map.insert("name", Value::from("test"));
map.insert("value", Value::from(42));

assert_eq!(map.len(), 2);
assert_eq!(map.get("name").unwrap().as_str(), Some("test"));

Implementations

impl Mapping

pub fn new() -> Self

Creates an empty mapping.

Examples

use noyalib::Mapping;
let m = Mapping::new();
assert!(m.is_empty());

pub fn with_capacity(capacity: usize) -> Self

Creates an empty mapping with the specified capacity.

Pre-allocates room for capacity entries to avoid rehashing during the first inserts.

Examples

use noyalib::Mapping;
let m = Mapping::with_capacity(16);
assert!(m.capacity() >= 16);

pub fn capacity(&self) -> usize

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

Examples

use noyalib::Mapping;
let m = Mapping::with_capacity(8);
assert!(m.capacity() >= 8);

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

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

Examples

use noyalib::Mapping;
let mut m = Mapping::new();
m.reserve(64);
assert!(m.capacity() >= 64);

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the mapping as much as possible.

Examples

use noyalib::Mapping;
let mut m = Mapping::with_capacity(64);
m.shrink_to_fit();
// capacity may now be 0 or any small implementation-defined value.

pub fn len(&self) -> usize

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

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
assert_eq!(m.len(), 1);

pub fn is_empty(&self) -> bool

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

Examples

use noyalib::Mapping;
assert!(Mapping::new().is_empty());

pub fn clear(&mut self)

Clears the mapping, removing all key-value pairs.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.clear();
assert!(m.is_empty());

pub fn insert(&mut self, key: impl Into<String>, 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.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
assert_eq!(m.insert("a", Value::from(1_i64)), None);
assert_eq!(m.insert("a", Value::from(2_i64)).and_then(|v| v.as_i64()), Some(1));

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

Returns true if the mapping contains the specified key.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
assert!(m.contains_key("a"));
assert!(!m.contains_key("b"));

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

Returns a reference to the value corresponding to the key.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
assert_eq!(m.get("a").and_then(Value::as_i64), Some(1));
assert!(m.get("b").is_none());

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

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

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
if let Some(v) = m.get_mut("a") {
    *v = Value::from(2_i64);
}
assert_eq!(m.get("a").and_then(Value::as_i64), Some(2));

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

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

Indexing follows insertion order (this is an IndexMap).

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("first", Value::from(1_i64));
m.insert("second", Value::from(2_i64));
assert_eq!(m.get_index(0).map(|(k, _)| k.as_str()), Some("first"));

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

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

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
if let Some((_, v)) = m.get_index_mut(0) {
    *v = Value::from(99_i64);
}
assert_eq!(m.get("a").and_then(Value::as_i64), Some(99));

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

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

This operation preserves the order of remaining elements (uses shift_remove semantics, O(n)). For order-agnostic O(1) removal, see Mapping::swap_remove.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
assert_eq!(m.remove("a").and_then(|v| v.as_i64()), Some(1));
assert!(m.remove("a").is_none());

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

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

This operation preserves the order of remaining elements.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
let (k, v) = m.remove_entry("a").unwrap();
assert_eq!(k, "a");
assert_eq!(v.as_i64(), Some(1));

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

Removes a key by swapping it with the last element.

This is O(1) but does not preserve order. For order-preserving removal, see Mapping::remove or Mapping::shift_remove.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
m.insert("c", Value::from(3_i64));
m.swap_remove("a");
// Order is no longer guaranteed; "c" might now sit where "a" was.
assert_eq!(m.len(), 2);

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

Removes a key by shifting all elements after it.

This preserves order but is O(n). Equivalent to Mapping::remove.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
m.shift_remove("a");
assert_eq!(m.iter().next().map(|(k, _)| k.as_str()), Some("b"));

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

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

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.entry("counter").or_insert(Value::from(0_i64));
if let Some(Value::Number(n)) = m.get_mut("counter") {
    if let Some(c) = n.as_i64() { *n = noyalib::Number::Integer(c + 1); }
}
assert_eq!(m.get("counter").and_then(Value::as_i64), Some(1));

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

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

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

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
m.insert("c", Value::from(3_i64));
m.retain(|_k, v| v.as_i64().unwrap_or(0) >= 2);
assert_eq!(m.len(), 2);
assert!(!m.contains_key("a"));

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

Returns an iterator over the key-value pairs in insertion order.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
let total: i64 = m.iter().filter_map(|(_, v)| v.as_i64()).sum();
assert_eq!(total, 3);

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

Returns a mutable iterator over the key-value pairs in insertion order.

Examples

use noyalib::{Mapping, Number, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
for (_, v) in m.iter_mut() {
    if let Value::Number(Number::Integer(n)) = v { *n *= 2; }
}
assert_eq!(m.get("a").and_then(Value::as_i64), Some(2));

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

Returns an iterator over the keys in insertion order.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
let keys: Vec<&str> = m.keys().map(String::as_str).collect();
assert_eq!(keys, &["a", "b"]);

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

Returns an iterator over the values in insertion order.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
let sum: i64 = m.values().filter_map(Value::as_i64).sum();
assert_eq!(sum, 3);

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

Returns a mutable iterator over the values in insertion order.

Examples

use noyalib::{Mapping, Number, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(10_i64));
m.insert("b", Value::from(20_i64));
for v in m.values_mut() {
    if let Value::Number(Number::Integer(n)) = v { *n /= 10; }
}
assert_eq!(m.get("a").and_then(Value::as_i64), Some(1));

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

Returns the first key-value pair in insertion order.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
assert_eq!(m.first().map(|(k, _)| k.as_str()), Some("a"));

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

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

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
if let Some((_, v)) = m.first_mut() { *v = Value::from(99_i64); }
assert_eq!(m.get("a").and_then(Value::as_i64), Some(99));

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

Returns the last key-value pair in insertion order.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
assert_eq!(m.last().map(|(k, _)| k.as_str()), Some("b"));

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

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

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
if let Some((_, v)) = m.last_mut() { *v = Value::from(99_i64); }
assert_eq!(m.get("b").and_then(Value::as_i64), Some(99));

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

Removes and returns the first key-value pair.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
let (k, _) = m.pop_first().unwrap();
assert_eq!(k, "a");
assert_eq!(m.len(), 1);

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

Removes and returns the last key-value pair.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
let (k, _) = m.pop_last().unwrap();
assert_eq!(k, "b");

pub fn sort_keys(&mut self)

Sorts the mapping by keys (lexicographic order).

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("c", Value::from(3_i64));
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
m.sort_keys();
let keys: Vec<&str> = m.keys().map(String::as_str).collect();
assert_eq!(keys, &["a", "b", "c"]);

pub fn reverse(&mut self)

Reverses the order of key-value pairs.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
m.insert("b", Value::from(2_i64));
m.reverse();
assert_eq!(m.first().map(|(k, _)| k.as_str()), Some("b"));

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

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

Extends the mapping with the contents of an iterator.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.extend([
    ("a".to_owned(), Value::from(1_i64)),
    ("b".to_owned(), Value::from(2_i64)),
]);
assert_eq!(m.len(), 2);

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

Consumes the mapping and returns its contents as an IndexMap.

Examples

use noyalib::{Mapping, Value};
let mut m = Mapping::new();
m.insert("a", Value::from(1_i64));
let inner = m.into_inner();
assert_eq!(inner.len(), 1);

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

Creates a mapping from an IndexMap.

Examples

use indexmap::IndexMap;
use noyalib::{Mapping, Value};
let mut src = IndexMap::new();
src.insert("a".to_owned(), Value::from(1_i64));
let m = Mapping::from_inner(src);
assert_eq!(m.get("a").and_then(Value::as_i64), Some(1));

Trait Implementations

impl Clone for Mapping

fn clone(&self) -> Mapping

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mapping

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

Formats the value using the given formatter.

impl Default for Mapping

fn default() -> Mapping

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Mapping

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Mapping

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

Formats the value using the given formatter.

impl Eq for Mapping

impl From<IndexMap<String, Value, FxBuildHasher>> for Mapping

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

Converts to this type from the input type.

impl From<IndexMap<String, Value>> for Mapping

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

Converts to this type from the input type.

impl From<Mapping> for Value

fn from(v: Mapping) -> Self

Converts to this type from the input type.

impl From<Mapping> for IndexMap<String, Value>

fn from(map: Mapping) -> Self

Converts to this type from the input type.

impl From<Mapping> for IndexMap<String, Value, FxBuildHasher>

fn from(map: Mapping) -> 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<Vec<(String, Value)>> for Mapping

fn from(v: Vec<(String, Value)>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl FromIterator<(String, Value)> for Mapping

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

Creates a value from an iterator.

impl Hash for Mapping

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 Mapping

fn index(&self, key: &str) -> &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<&str> for Mapping

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

Mutably index into the mapping by key.

Panics

Panics if the key is not present in the mapping.

impl IntoIterator for Mapping

type Item = (String, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter<String, 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 Mapping

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

The type of the elements being iterated over.

type IntoIter = Iter<'a, String, 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 Mapping

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

The type of the elements being iterated over.

type IntoIter = IterMut<'a, String, 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 Mapping

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 Mapping

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

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 Mapping

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 Mapping

impl Value for Mapping

Available on crate feature sval only.

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.