Skip to main content

Header

Struct Header 

Source
pub struct Header {
Show 19 fields pub magic: [u8; 4], pub format_version: u8, pub engine_kind: u8, pub flags: u16, pub entry_count: u32, pub string_pool_offset: u32, pub string_pool_size: u32, pub entry_table_offset: u32, pub fst_code_index_offset: u32, pub fst_code_index_size: u32, pub fst_word_index_offset: u32, pub fst_word_index_size: u32, pub bigram_offset: u32, pub bigram_size: u32, pub embedding_offset: u32, pub embedding_dim: u16, pub embedding_dtype: u8, pub reserved: u8, pub sha256_of_payload: [u8; 32],
}
Expand description

Header, mirrors the on-disk 64-byte layout exactly. All integer fields are little-endian on disk; the public struct holds host-byte values (decoded on parse, encoded on to_bytes).

Fields§

§magic: [u8; 4]§format_version: u8§engine_kind: u8§flags: u16§entry_count: u32§string_pool_offset: u32§string_pool_size: u32§entry_table_offset: u32§fst_code_index_offset: u32§fst_code_index_size: u32§fst_word_index_offset: u32§fst_word_index_size: u32§bigram_offset: u32§bigram_size: u32§embedding_offset: u32§embedding_dim: u16§embedding_dtype: u8§reserved: u8§sha256_of_payload: [u8; 32]

Implementations§

Source§

impl Header

Source

pub fn to_bytes(&self) -> [u8; 64]

Encode the header into a fixed 64-byte buffer (little-endian).

Source

pub fn parse(buf: &[u8]) -> Option<Self>

Decode a header from on-disk bytes. Returns None if buf is too small or the magic does not match.

Trait Implementations§

Source§

impl Clone for Header

Source§

fn clone(&self) -> Header

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 Header

Source§

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

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

impl PartialEq for Header

Source§

fn eq(&self, other: &Header) -> 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 Copy for Header

Source§

impl Eq for Header

Source§

impl StructuralPartialEq for Header

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> Same for T

Source§

type Output = T

Should always be Self
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.