Skip to main content

SectionEntry

Struct SectionEntry 

Source
pub struct SectionEntry {
    pub name_index: u8,
    pub priority: Priority,
    pub offset: u32,
    pub length: u32,
    pub token_count: u16,
    pub flags: u32,
}
Expand description

A single section entry in the section table

Fields§

§name_index: u8

String-table index of this section’s name

§priority: Priority

Truncation priority (0-255, higher = more important)

§offset: u32

Byte offset to section data (from start of file)

§length: u32

Section data length in bytes

§token_count: u16

Pre-computed token count estimate

§flags: u32

Section flags: bits 0-1 = classification, bits 2+ section-specific

Implementations§

Source§

impl SectionEntry

Source

pub fn new(name_index: u8, offset: u32, length: u32) -> Self

Create a new section entry. Callers normally set the real priority via with_priority (from the canonical chunk table); the default is medium.

Source

pub fn with_priority(self, priority: Priority) -> Self

Create with explicit priority

Source

pub fn with_token_count(self, count: u16) -> Self

Create with explicit token count

Source

pub fn with_flags(self, flags: u32) -> Self

Create with section-specific flags

Source

pub fn with_classification(self, classification: ChunkClassification) -> Self

Set classification in the low 2 bits of flags

Source

pub fn classification(&self) -> ChunkClassification

Get the classification from the low 2 bits of flags

Source

pub fn section_flags(&self) -> u32

Get section-specific flags (bits 2+, excluding classification)

Source

pub fn write<W: Write>(&self, writer: &mut W) -> FafbResult<()>

Write entry to a byte buffer

Source

pub fn to_bytes(&self) -> FafbResult<Vec<u8>>

Write entry to a new Vec<u8>

Source

pub fn read<R: Read>(reader: &mut R) -> FafbResult<Self>

Read entry from a byte buffer

Source

pub fn from_bytes(data: &[u8]) -> FafbResult<Self>

Read entry from a byte slice

Source

pub fn validate_bounds(&self, file_size: u32) -> FafbResult<()>

Check if this section’s data range is valid within a file

Trait Implementations§

Source§

impl Clone for SectionEntry

Source§

fn clone(&self) -> SectionEntry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SectionEntry

Source§

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

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

impl Eq for SectionEntry

Source§

impl PartialEq for SectionEntry

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 StructuralPartialEq for SectionEntry

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.