Struct DataItem 

pub struct DataItem { /* private fields */ }

Represents a data item with header information, names, a value payload, and a checksum for validation.

Implementations

impl DataItem

pub fn item_size(&self) -> u32

Calculates the total binary size of the DataItem.

This includes the fixed header size, sizes of the group name, item name, value, and the checksum (2 bytes).

Returns

• The full size of the item as a u32 value.

pub fn item_header(&self) -> &DataItemHeader

Provides a reference to the DataItemHeader of this item.

Returns

• A reference to the contained DataItemHeader.

pub fn name(&self) -> &str

Returns the name of the item as a string slice.

Returns

• A string slice representing the item name.

pub fn group(&self) -> &str

Returns the group name of the item as a string slice.

Returns

• A string slice representing the group name.

pub fn data(&self) -> &[u8]

Returns a byte slice containing the item’s value data.

Returns

• A slice of bytes representing the value of the data item.

Trait Implementations

impl Debug for DataItem

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

Formats the value using the given formatter.

impl Default for DataItem

fn default() -> Self

Creates a new DataItem with default values.

Returns

• A DataItem instance where all fields are initialized to their default states, including an empty group and item names, zero checksum, and an empty value vector.

impl FromStream for DataItem

fn read_from<R>(&mut self, reader: &mut R) -> Result<(), Error>

where R: Read + Seek,

Reads a DataItem from a binary stream.

This method reads the header first, then if the status is not Empty or Unknown, it reads the group name, item name, value bytes, and checksum from the stream.

The group and item names are read as UTF-8 strings and exclude the trailing null byte.

Parameters

• reader: A mutable reference to a reader implementing Read and Seek.

Returns

• Ok(()) if the item was read successfully.
• Err(Error) if any I/O error occurs or UTF-8 conversion fails.