Struct ToonMap 

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

An ordered map of string keys to TOON values.

This is a thin wrapper around IndexMap that maintains insertion order, which is important for deterministic TOON serialization.

Examples

use serde_toon::{ToonMap, Value};

let mut map = ToonMap::new();
map.insert("first".to_string(), Value::from(1));
map.insert("second".to_string(), Value::from(2));

// Iteration maintains insertion order
let keys: Vec<_> = map.keys().cloned().collect();
assert_eq!(keys, vec!["first", "second"]);

Implementations

impl ToonMap

pub fn new() -> Self

Creates an empty ToonMap.

Examples

use serde_toon::ToonMap;

let map = ToonMap::new();
assert!(map.is_empty());

pub fn with_capacity(capacity: usize) -> Self

Creates an empty ToonMap with the specified capacity.

Examples

use serde_toon::ToonMap;

let map = ToonMap::with_capacity(10);
assert!(map.is_empty());

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

Inserts a key-value pair into the map.

If the map already contained this key, the old value is returned.

Examples

use serde_toon::{ToonMap, Value};

let mut map = ToonMap::new();
assert!(map.insert("key".to_string(), Value::from(42)).is_none());
assert!(map.insert("key".to_string(), Value::from(43)).is_some());

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

Returns a reference to the value corresponding to the key.

Examples

use serde_toon::{ToonMap, Value};

let mut map = ToonMap::new();
map.insert("key".to_string(), Value::from(42));
assert_eq!(map.get("key").and_then(|v| v.as_i64()), Some(42));

pub fn len(&self) -> usize

Returns the number of elements in the map.

Examples

use serde_toon::{ToonMap, Value};

let mut map = ToonMap::new();
assert_eq!(map.len(), 0);
map.insert("key".to_string(), Value::from(42));
assert_eq!(map.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Examples

use serde_toon::ToonMap;

let map = ToonMap::new();
assert!(map.is_empty());

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

Returns an iterator over the keys of the map, in insertion order.

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

Returns an iterator over the values of the map, in insertion order.

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

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

Trait Implementations

impl Clone for ToonMap

fn clone(&self) -> ToonMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToonMap

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

Formats the value using the given formatter.

impl Default for ToonMap

fn default() -> Self

Returns the “default value” for a type.

impl From<HashMap<String, Value>> for ToonMap

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

Converts to this type from the input type.

impl From<ToonMap> for HashMap<String, Value>

fn from(map: ToonMap) -> Self

Converts to this type from the input type.

impl From<ToonMap> for Value

fn from(value: ToonMap) -> Self

Converts to this type from the input type.

impl FromIterator<(String, Value)> for ToonMap

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

Creates a value from an iterator.

impl IntoIterator for ToonMap

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 PartialEq for ToonMap

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