Struct il2_iltags::tags::standard::explicit::ILDictTag

pub struct ILDictTag { /* fields omitted */ }

This struct implements the standard dictionary tag. It maps strings to tags.

To ensure maximum the stability of the serialized data, the keys are sorted according to the lexicographic order before the serialization.

By default it sets the tag id to IL_DICTIONARY_TAG_ID.

Implementations

impl ILDictTag

pub fn new() -> Self

Creates a new instance of this struct.

pub fn with_id(id: u64) -> Self

Creates a new instance of this struct with the specified initial value.

Arguments:

• value: A byte slice with the initial value;

pub fn value(&self) -> &HashMap<String, Box<dyn ILTag>>

Returns an immutable reference to the std::collections::hash_map::HashMap used to hold the key/value pairs.

pub fn mut_value(&mut self) -> &mut HashMap<String, Box<dyn ILTag>>

Returns a mutable reference to the std::collections::hash_map::HashMap used to hold the key/value pairs.

pub fn len(&self) -> usize

Returns the number of pairs inside this tag.

pub fn is_empty(&self) -> bool

Returns true if this tag is empty or false otherwise.

pub fn insert(&mut self, k: &str, v: Box<dyn ILTag>) -> Option<Box<dyn ILTag>>

Inserts a new pair into this tag. It is a shortcut to:

let ret = tag.mut_value().insert(String::from(k), v);

Arguments: k: The key; v: The boxed value;

Returns:

• Some(old): The value of the older value;
• None: If it is the first insertion of this key;

pub fn get(&self, k: &str) -> Option<&dyn ILTag>

Returns an immutable reference to the value associated with a given key. It is a shortcut to:

let ret = match tag.mut_value().get(k) {
    Some(t) => Some(t.as_ref()),
    None => None,
}

Arguments: k: The key;

Returns:

• Some(v): The value associated with the key;
• None: If the key is not inside this tag;

Trait Implementations

impl Default for ILDictTag

fn default() -> Self

Returns the “default value” for a type.

impl DefaultWithId for ILDictTag

fn default_with_id(id: u64) -> Self

Creates a default tag with.

impl ILTag for ILDictTag

fn id(&self) -> u64

Returns the ID of the tag.

fn as_any(&self) -> &dyn Any

Returns a reference as Any.

fn as_mut_any(&mut self) -> &mut dyn Any

Returns a mutable reference as Any.

fn value_size(&self) -> u64

Retuns the size of the serialized value in bytes.

fn serialize_value(&self, writer: &mut dyn Writer) -> Result<()>

Serializes the payload of this tag.

fn deserialize_value(
    &mut self,
    factory: &dyn ILTagFactory,
    value_size: usize,
    reader: &mut dyn Reader
) -> Result<()>

Deserializes the value.

fn is_implicity(&self) -> bool

Verifies if this tag is implicity.

fn is_reserved(&self) -> bool

Verifies if this tag is reserved.

fn size(&self) -> u64

Returns the total size of the tag in bytes.

fn serialize(&self, writer: &mut dyn Writer) -> Result<()>

Serializes this tag.

fn to_bytes(&self) -> Result<Vec<u8>>

Serializes the given tag into an array of bytes.