Struct kserd::ds::Accessor

pub struct Accessor<T>(_);

Accessor provides a wrapper around a value, adding additional accessing methods.

Containers

A container accessor can be constructed through Value::cntr or Value::cntr_mut. These give you immutable or mutable access to the underlying map store, along with additional methods for accessing an entry if it matches the name + the type of Value.

Example

let mut cntr = Value::new_cntr(vec![
    ("a", Kserd::new_str("Hello")),
    ("b", Kserd::new_num(101))
]).unwrap();

let mut accessor = cntr.cntr_mut().unwrap();

assert_eq!(accessor.get_str("a"), Some("Hello"));
assert_eq!(accessor.get_str("b"), None); // not a string
assert_eq!(accessor.get_num("b"), Some(101.into()));

// mutating is also possible
accessor.get_str_mut("a").map(|s| s.push_str(", world!"));

assert_eq!(accessor.get_str("a"), Some("Hello, world!"));

Implementations

impl<'a, T> Accessor<T> where
    T: Deref<Target = BTreeMap<Kstr<'a>, Kserd<'a>>>, 

Immutable access to a container’s fields.

pub fn get_unit<K: ?Sized>(&self, name: &K) -> Option<()> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a unit value along the key name.

pub fn get_bool<K: ?Sized>(&self, name: &K) -> Option<bool> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a boolean value along the key name.

pub fn get_num<K: ?Sized>(&self, name: &K) -> Option<Number> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a numeric value along the key name.

pub fn get_str<'b, K: ?Sized>(&'b self, name: &K) -> Option<&'b str> where
    'a: 'b,
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a string value along the key name.

pub fn get_barr<'b, K: ?Sized>(&'b self, name: &K) -> Option<&'b [u8]> where
    'a: 'b,
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a byte array value along the key name.

pub fn get_tuple<K: ?Sized>(&self, name: &K) -> Option<&Vec<Kserd<'a>>> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a tuple value along the key name.

pub fn get_seq<K: ?Sized>(&self, name: &K) -> Option<&Vec<Kserd<'a>>> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a sequence value along the key name.

pub fn get_tuple_or_seq<K: ?Sized>(&self, name: &K) -> Option<&Vec<Kserd<'a>>> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a tuple or sequence value along the key name.

pub fn get_cntr<K: ?Sized>(
    &self,
    name: &K
) -> Option<Accessor<&BTreeMap<Kstr<'a>, Kserd<'a>>>> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a container value along the key name.

pub fn get_map<K: ?Sized>(
    &self,
    name: &K
) -> Option<&BTreeMap<Kserd<'a>, Kserd<'a>>> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a map value along the key name.

impl<'a, T> Accessor<T> where
    T: DerefMut<Target = BTreeMap<Kstr<'a>, Kserd<'a>>>, 

Mutable access to a container’s fields.

pub fn get_bool_mut<'b, K: ?Sized>(
    &'b mut self,
    name: &K
) -> Option<&'b mut bool> where
    'a: 'b,
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a boolean value along the key name.

pub fn get_num_mut<'b, K: ?Sized>(
    &'b mut self,
    name: &K
) -> Option<&'b mut Number> where
    'a: 'b,
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a numeric value along the key name.

pub fn get_str_mut<'b, K: ?Sized>(
    &'b mut self,
    name: &K
) -> Option<&'b mut String> where
    'a: 'b,
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a string value along the key name.

pub fn get_barr_mut<'b, K: ?Sized>(
    &'b mut self,
    name: &K
) -> Option<&'b mut Vec<u8>> where
    'a: 'b,
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a byte array value along the key name.

pub fn get_tuple_mut<K: ?Sized>(
    &mut self,
    name: &K
) -> Option<&mut Vec<Kserd<'a>>> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a tuple value along the key name.

pub fn get_seq_mut<K: ?Sized>(
    &mut self,
    name: &K
) -> Option<&mut Vec<Kserd<'a>>> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a sequence value along the key name.

pub fn get_tuple_or_seq_mut<K: ?Sized>(
    &mut self,
    name: &K
) -> Option<&mut Vec<Kserd<'a>>> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a tuple or sequence value along the key name.

pub fn get_cntr_mut<K: ?Sized>(
    &mut self,
    name: &K
) -> Option<Accessor<&mut BTreeMap<Kstr<'a>, Kserd<'a>>>> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a container value along the key name.

pub fn get_map_mut<K: ?Sized>(
    &mut self,
    name: &K
) -> Option<&mut BTreeMap<Kserd<'a>, Kserd<'a>>> where
    K: Ord,
    Kstr<'a>: Borrow<K>, 

Returns if the container has a map value along the key name.

Trait Implementations

impl<T: Debug> Debug for Accessor<T>

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

Formats the value using the given formatter.

impl<T> Deref for Accessor<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Accessor<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: PartialEq> PartialEq<Accessor<T>> for Accessor<T>

fn eq(&self, other: &Accessor<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Accessor<T>) -> bool

This method tests for !=.

impl<T> StructuralPartialEq for Accessor<T>