Struct il2_iltags::tags::raw::RawTagOffset

pub struct RawTagOffset { /* fields omitted */ }

This struct implements the raw tag offset information. It stores the information about a tag, such as its id and the location of its parts inside a sequence of bytes.

It does not store references to the original byte stream, just the information about a tags inside it.

Implementations

impl RawTagOffset

pub fn new(id: u64, offset: u64, header_size: u64, value_size: u64) -> Self

Creates a new RawTagOffset.

pub fn id(&self) -> u64

Returns the ID of the tag.

pub fn offset(&self) -> u64

Retuns the offset of the tag.

pub fn size(&self) -> u64

Returns the total tag size.

pub fn value_offset(&self) -> u64

Returns the offset of the tag’s value.

pub fn value_size(&self) -> u64

Returns the size of the tag’s value.

pub fn next_tag_offset(&self) -> u64

Returns the offset of the next tag.

pub fn value_start(&self) -> usize

Returns the initial offset of this tag’s value. It is usefull to create slices on the raw data.

pub fn value_end(&self) -> usize

Returns the end offset of the value. It is usefull to create slices on the raw data.

pub fn tag_start(&self) -> usize

Returns the start offset of the tag. It is usefull to create slices on the raw data.

pub fn tag_end(&self) -> usize

Returns the end offset of the tag.

pub fn tag_slice<'a>(&self, raw: &'a [u8]) -> &'a [u8]

Returns a slice within raw that points to the value of the tag pointed by this instance.

Arguments:

• raw: The array that contains the tag indexe by this instance;

Returns a immutable slice within the raw that contains the value of the tag.

pub fn value_slice<'a>(&self, raw: &'a [u8]) -> &'a [u8]

Returns a slice within raw that points to the value of the tag pointed by this instance.

Arguments:

• raw: The array that contains the tag indexe by this instance;

Returns a immutable slice within the raw that contains the value of the tag.

pub fn map_to_parent_space(&self, parent: &Self) -> Result<Self>

Creates a new instance of this struct that maps the offsets to the same space of the parent. It assumes that this instance is contained by the parent (is within its value) and assumes 0 as the start of the parent’s value.

For example:

• Parent’s value offset = 10;
• This offset = 5;

The result will be a new instance that maps the beginning of this tag to 15. This allows the extraction of the tag directly from the byte sequence where the parent resides.

This method will perform only basic validations to ensure that this instace an indeed fit inside the parent but if those two instances are unrelated, the behavior of this method is undefined.

Arguments:

• parent: The parent of this instance;

Returns a new instance of Self that points to the same tag value but relative to the offset space of the parent.

Trait Implementations

impl Clone for RawTagOffset

fn clone(&self) -> RawTagOffset

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RawTagOffset

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

Formats the value using the given formatter.

impl Default for RawTagOffset

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<RawTagOffset> for RawTagOffset

fn eq(&self, other: &RawTagOffset) -> bool

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

fn ne(&self, other: &RawTagOffset) -> bool

This method tests for !=.

impl Copy for RawTagOffset

impl StructuralPartialEq for RawTagOffset