Struct libradicl::rad_types::TagMap

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

This type represents a mapping from TagDescs to a corresponding set of values conforming to these descriptions (i.e. in terms of types). The TagMap allows you to fetch the value for a specific tag by name or index, or to add values to a corresponding set of descriptions.

Implementations

impl<'a> TagMap<'a>

pub fn with_keyset(keyset: &'a [TagDesc]) -> Self

Create a new TagMap whose set of keys is determined by the provided keyset. This will have one value slot for each provided key.

pub fn add_checked(&mut self, val: TagValue) -> bool

Try to add the next tag value. If there is space and the type matches, add it and return true, otherwise return false.

pub fn add(&mut self, val: TagValue)

add the next TagValue to the data for this TagMap. This function doesn’t check if the type is correct or if too many tag values have been added. It should only be used when one is certain that the next tag value appropriately matches the next available key.

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

get the value for the tag associated with the name key, returns Some(&TagValue) for the appropriate tag if it exists, and None otherwise.

pub fn get_at_index(&self, idx: usize) -> Option<&TagValue>

get the value for the tag at index idx returns Some(&TagValue) if idx is in bounds and None otherwise.

Trait Implementations

impl<'a> Debug for TagMap<'a>

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

Formats the value using the given formatter.

impl<'a> Index<usize> for TagMap<'a>

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

Returns a reference to the TagValue in the TagMap at the provided index, panics if index is out of bounds.

type Output = TagValue

The returned type after indexing.