Module il2_iltags::tags

This module contains the implementation of the IL2 ILTags standard.

Implicit vs Explicit tags

This library contains 2 types of tags, the implicit and the explicit tags.

The implicit tags have their value lengths predefined. This allows them to be more compact because they do not not store the size of the values in the tag serialization. Only the standard built-in tags with IDs lower than 16 are defined as such.

All tags with ID greater than 15 are considered explicit. Explicit tags encode all fields and have no such limitations.

Standard vs custom tags

The IL2 ILTags standard defined 2 classes of tags, the standard tags and custom tags.

The standard tags are defined by IL2 ILTags and defines most of basic data types that can be used by all applications. The standard tags are reserved by the standard and should not be redefined by applications in order to avoid conflicts with future versions of the standard. All tags with IDs up to 31 are considered reserved.

The custom tags can be freely defined by the applications and must have the ID greater than 31.

Modules

standard

This is module defines all standard tags and tag factories.

util

This module contains some utility functions that may help the usage and/or implementation of this library.

Structs

ILDefaultTagCreator

This template struct is used to implement the ILTagCreator trait for all ILTags that also implement Default.

ILDefaultWithIdTagCreator

This template struct is used to implement the ILTagCreator trait for all ILTags that also implement DefaultWithId.

ILRawTag

This struct implements a raw tag. It can be used to store any non explicit tag.

ILTagCreatorEngine

This struct implements an engine that maps the ILTagCreators to the associated tag ID. It can be used as a component to implement ILTagFactory trait.

Enums

ErrorKind

Definition of the errors from this package.

Constants

IMPLICIT_ID_MAX

Maximum tag id value for implicit tags.

MAX_TAG_SIZE

Maximum tag size that can be handled by this library. It in this version it is set to 512MB.

RESERVED_ID_MAX

Maximum tag id value for reserved tags.

Traits

DefaultWithId

This trait defines a variant of the std::default::Default trait that takes an id as a parameter.

ILTag

This trait must be implemented by all ILTags on this library. It defines the basic methods for tag identification, serialization and deserialization of values.

ILTagCreator

This trait must be implemented by all tag creators. A tag creator is used by ILTagCreatorEngine to create new tag instances.

ILTagFactory

This trait must be implemented by all tag factories. Factories are used to deserialize tags into the most appropriate concreate implemetation that will handle a given tag id.

Functions

deserialize_bytes

Deserializes a byte array of a given size.

deserialize_bytes_into_vec

Deserializes a byte array of a given size into a vector.

deserialize_ilint

Unserializes an ILInt value.

is_implicit_tag

Verifies if a given tag id represents an implicit tag.

is_reserved_tag

Verifies if a given tag id represents a reserved tag.

serialize_bytes

Serializes a byte array.

serialize_ilint

Serializes an u64 as an ILInt value.

tag_downcast_mut

Downcasts a ILTag to its concrete type as a mutable reference.

tag_downcast_ref

Downcasts a ILTag to its concrete type.

tag_id_downcast_mut

Downcasts a ILTag to its concrete type as a mutable reference. It fails if the tag id or the concrete type does not match.

tag_id_downcast_ref

Downcasts a ILTag to its concrete type. It fails if the tag id or the concrete type does not match.

tag_size_to_usize

This function converts the tag size as u64 into a usize value. It checks if the tag size falls within the maximum size of a tag that this library accepts.

Type Definitions

Result

A specialized std::result::Result generated by functions and methods from this package.