Skip to main content

GroupHeader

Struct GroupHeader 

Source
#[repr(C, packed(1))]
pub struct GroupHeader { pub block_length: u16, pub num_in_group: u16, }
Expand description

Repeating group header (4 bytes).

The group header precedes each repeating group and contains:

  • Block length: Size of each group entry in bytes
  • Num in group: Number of entries in the group

§Wire Format

+0: blockLength  (u16, 2 bytes)
+2: numInGroup   (u16, 2 bytes)

Fields§

§block_length: u16

Length of each group entry in bytes.

§num_in_group: u16

Number of entries in the group.

Implementations§

Source§

impl GroupHeader

Source

pub const ENCODED_LENGTH: usize = 4

Encoded length of the group header in bytes.

Source

pub const fn new(block_length: u16, num_in_group: u16) -> Self

Creates a new group header with the specified values.

§Arguments
  • block_length - Length of each group entry in bytes
  • num_in_group - Number of entries in the group
Source

pub fn wrap<B: ReadBuffer + ?Sized>(buffer: &B, offset: usize) -> Self

Wraps a buffer and decodes the group header at the given offset.

§Arguments
  • buffer - Buffer to read from
  • offset - Byte offset to start reading
§Panics

Panics if the buffer is too short.

Source

pub fn encode<B: WriteBuffer + ?Sized>(&self, buffer: &mut B, offset: usize)

Encodes the group header to the buffer at the given offset.

§Arguments
  • buffer - Buffer to write to
  • offset - Byte offset to start writing
Source

pub const fn group_size(&self) -> usize

Returns the total size of the group (header + all entries).

Source

pub const fn is_empty(&self) -> bool

Returns true if the group is empty.

Trait Implementations§

Source§

impl Clone for GroupHeader

Source§

fn clone(&self) -> GroupHeader

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GroupHeader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GroupHeader

Source§

fn default() -> GroupHeader

Returns the “default value” for a type. Read more
Source§

impl PartialEq for GroupHeader

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for GroupHeader

Source§

impl Eq for GroupHeader

Source§

impl StructuralPartialEq for GroupHeader

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.