Struct Dictionary 

pub struct Dictionary<'a> { /* private fields */ }

A validated Dictionary. Every member is kept in order; a repeated key’s last value wins in get and index_into.

Examples

use parse_net::sfv::{self, BareItem, Member};

let d = sfv::parse_dictionary(b"a=1, b")?;
assert_eq!(d.len(), 2);
assert!(matches!(d.get("b"), Some(Member::Item(i)) if i.bare == BareItem::Boolean(true)));

Implementations

impl Dictionary<'_>

pub fn to_owned(&self) -> OwnedDictionary

Available on crate feature alloc only.

Copies the dictionary (one allocation).

Examples

use parse_net::sfv;

let d = sfv::parse_dictionary(b"a=1, b")?;
assert_eq!(d.to_owned().as_view(), d);

impl<'a> Dictionary<'a>

pub fn iter(&self) -> DictIter<'a>

The members with their keys, in order (repeats included).

Examples

use parse_net::sfv;

let d = sfv::parse_dictionary(b"a=1, b=2, a=3")?;
assert!(d.iter().map(|(k, _)| k).eq(["a", "b", "a"]));

pub fn get(&self, key: &str) -> Option<Member<'a>>

The member for key: the last occurrence.

Examples

use parse_net::sfv::{self, BareItem, Member};

let d = sfv::parse_dictionary(b"a=1, b=(x y)")?;
assert!(matches!(d.get("b"), Some(Member::InnerList(l)) if l.len() == 2));
assert!(d.get("c").is_none());

pub fn index_into<'i>( &self, slots: &'i mut [(&'a str, Member<'a>)], ) -> Result<&'i [(&'a str, Member<'a>)], ParseError>

Fills slots with one entry per distinct key (the last value for a repeated key), in first-seen order, and returns the filled part: for callers that look up many keys.

Errors

ErrorKind::BufferTooSmall when there are more distinct keys than slots.

Examples

use parse_net::sfv::{self, BareItem, Item, Member};

let d = sfv::parse_dictionary(b"a=1, b=2, a=3")?;
let mut slots = [("", Member::Item(Item::new(BareItem::Boolean(false)))); 4];
let index = d.index_into(&mut slots)?;
assert_eq!(index.len(), 2);
assert!(matches!(index[0], ("a", Member::Item(i)) if i.bare == BareItem::Integer(3)));

pub const fn len(&self) -> usize

The number of members, repeats included.

Examples

assert_eq!(parse_net::sfv::parse_dictionary(b"a=1, a=2")?.len(), 2);

pub const fn is_empty(&self) -> bool

Whether the dictionary is empty.

Examples

assert!(!parse_net::sfv::parse_dictionary(b"a")?.is_empty());

Trait Implementations

impl<'a> Clone for Dictionary<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Dictionary<'a>

impl<'a> Debug for Dictionary<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Dictionary<'a>

impl<'a> Hash for Dictionary<'a>

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<'a> PartialEq for Dictionary<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Dictionary<'a>