Struct Table

#[repr(C, align(16))]
pub struct Table { /* private fields */ }

A table entry in the file format. Tables are 48 bytes in length when stored.

Implementations

impl Table

pub const SIZE: usize = 48usize

Size of the table entry.

pub fn create() -> TableBuilder

Create a table using the builder.

pub fn identifier(&self) -> Identifier

Get the table identifier.

pub fn metadata_length(&self) -> u64

Get the metadata length.

pub fn metadata_length_mut(&mut self) -> &mut u64

Get the metadata length mutably

pub fn metadata_offset(&self) -> u64

Get the metadata offset in the file. This is an absolute offset within the file, i.e. zero based.

pub fn metadata_offset_mut(&mut self) -> &mut u64

Get the metadata offset mutably.

pub fn offset(&mut self, data_length: u64, chunk_count: u32)

Helper to collapse tables into parents.

pub fn child_count(&self) -> u32

Get the child table count.

pub fn sibling(&self) -> u32

Get the index offset from this entry to its sibling. Zero if there is no sibling.

pub fn sibling_mut(&mut self) -> &mut u32

Get the sibling index mutably.

pub fn chunk_index(&self) -> u32

Get the index of the first chunk owned by this table.

pub fn chunk_count(&self) -> u32

Get the number of chunks owned by this table.

pub fn read<E: ByteOrder>(reader: &mut dyn Read) -> Result<Self>

Read a table from the given stream.

pub fn write<E: ByteOrder>(self, writer: &mut dyn Write) -> Result<()>

Write a table to the given stream.

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.

impl Default for Table

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Table

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Table

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Table

impl Eq for Table

impl StructuralPartialEq for Table