Struct il2_iltags::tags::payload::ILGenericPayloadTag

pub struct ILGenericPayloadTag<T: ILTagPayload + Default> { /* fields omitted */ }

This generic struct implements a tag that contains a generic payload. The payload must handle all details about the data types and its serialization/ deserialization procedures while this struct will handle the ILTag related functionalities.

This struct implements the trait DefaultWithId which allows it to be used in conjuction with the generic crate::tags::ILDefaultWithIdTagCreator.

A new tag with a custom payload can be defined as follows:

use il2_iltags::io::{Reader, Writer};
use il2_iltags::tags::{ErrorKind, ILTagFactory, Result};
use il2_iltags::tags::payload::*;

struct DummyPayload{};

impl ILTagPayload for DummyPayload {
    fn serialized_size(&self) -> usize {
        // Zero as it has no fields
        0
    }

    fn serialize(&self, writer: &mut dyn Writer) -> Result<()> {
        // Nothing to do as it has no fields
        Ok(())
    }

    fn deserialize(&mut self, _factory: &dyn ILTagFactory, value_size: usize, _reader: &mut dyn Reader) -> Result<()> {
         // The size must be zero as it has no fields
        match value_size {
            0 => Ok(()),
            _ => Err(ErrorKind::CorruptedData),
        }
    }
}

type DummyPayloadTag = ILGenericPayloadTag<DummyPayload>;

In this example, the tag uses DummyPayload as its payload, defining a new tag type DummyPayloadTag.

Easier access to the payload with Deref and DerefMut

Although it this struct is not a smart pointer per se, it is a container for the inner payload implementation and has no other purposed. Given that, the most of the operatons will happen around the payload, not around the tag methods.

Given that, we decided to implement std::ops::Deref and std::ops::DerefMut in order to make the access to the methods of the inner payload easier even if this practice is not recommended for non smart pointer containers.

Since 1.1.1.

Implementations

impl<T: ILTagPayload + Send + Default> ILGenericPayloadTag<T>

pub fn new(id: u64) -> Self

pub fn payload(&self) -> &T

pub fn mut_payload(&mut self) -> &mut T

Trait Implementations

impl<T: ILTagPayload + Send + Default> DefaultWithId for ILGenericPayloadTag<T>

fn default_with_id(id: u64) -> Self

Creates a default tag with.

impl<T: ILTagPayload + Send + Default> Deref for ILGenericPayloadTag<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: ILTagPayload + Send + Default> DerefMut for ILGenericPayloadTag<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: ILTagPayload + Send + Default + Sync> ILTag for ILGenericPayloadTag<T>

fn id(&self) -> u64

Returns the ID of the tag.

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 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 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.