Struct Entry

#[repr(C)]
pub struct Entry<T: StringFormat> { /* private fields */ }

Implementations

impl<T: StringFormat> Entry<T>

pub const WIDE: u16 = 32_768u16

Constant to represent a “wide” entry. This is used for determining if the entry is wide.

pub const REF_COUNT_MASK: u16 = 32_767u16

Mask used for reference count in flags.

pub const LENGTH_MASK: u32 = 16_777_215u32

Mask used to extract the length value from the length_or_right union.

pub fn acquire(&self)

Acquire the entry by incrementing its reference count.

This method ensures atomicity by loading the current value of the reference count, and then attempts to increment the reference count. The operation is performed in a loop to ensure that the reference count does not overflow.

pub const fn crc(&self) -> u16

Get the CRC checksum of the entry.

pub const fn len(&self) -> u32

Returns the length of the entry, extracting it from the length_or_right union.

This corresponds to the length or size function in the C++ API.

Returns

Returns the length stored in the length_or_right union after applying the LENGTH_MASK.

pub fn as_raw(&self) -> *const T::Unit

Returns a raw pointer to the entry’s data.

This corresponds to the data function in the C++ API.

pub unsafe fn release(entry: &*const T::Unit)

Releases the entry and performs the necessary cleanup. This function is unsafe because it involves dereferencing raw pointers.

Safety

• The caller must ensure that the entry is properly allocated and not already released.
• Not having a double free.

Trait Implementations

impl<T: Debug + StringFormat> Debug for Entry<T>

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

Formats the value using the given formatter.