Struct FttsqReader 

pub struct FttsqReader { /* private fields */ }

A parsed, validated .fttsq directory over a buffer the reader does not own.

Implementations

impl FttsqReader

pub fn open(bytes: &[u8]) -> Result<Self, FttsqError>

Parses and fully validates an artifact, including every section digest.

Digest verification is not optional here. A reader that can be asked to skip it grows a caller that always skips it, and then corruption surfaces as audio rather than as an error.

Errors

Returns a named FttsqError for any structural, range, or integrity violation.

pub fn parse_directory(bytes: &[u8]) -> Result<Self, FttsqError>

Parses and structurally validates without computing digests.

For inspection tooling (ftts inspect) over an artifact whose bytes are not all present — listing a remote artifact’s tensors, say. Never use this to load weights: it does not prove the payload is intact.

Errors

Returns a named FttsqError for any structural or range violation.

pub fn verify_digests(&self, bytes: &[u8]) -> Result<(), FttsqError>

Recomputes and checks every section digest against bytes.

Errors

Returns FttsqError::DigestMismatch naming the first corrupt section.

pub const fn format_version(&self) -> u32

The format version the artifact declares.

pub fn model_family(&self) -> &str

The model family the artifact was built from.

pub fn source_sha256(&self) -> &str

SHA-256 of the upstream checkpoint this artifact was converted from.

pub fn license_notice(&self) -> &str

The Apache-2.0 §4 attribution notice. Guaranteed non-empty.

pub const fn model_config(&self) -> &Value

The frozen copy of the upstream model config.

pub const fn quantization_manifest(&self) -> &Value

The per-tensor quantization policy actually applied, which the license notice references.

pub fn sections(&self) -> &[SectionEntry]

Every declared section, in declaration order.

pub fn tensors(&self) -> &[TensorEntry]

Every declared tensor, in declaration order.

pub fn section(&self, name: &str) -> Option<&SectionEntry>

Looks a section up by name.

pub fn tensor(&self, name: &str) -> Option<&TensorEntry>

Looks a tensor up by name.

pub fn sections_in_class(&self, class: AccessClass) -> Vec<&SectionEntry>

Sections belonging to one access class.

pub fn tensor_bytes<'a>( &self, name: &str, bytes: &'a [u8], ) -> Result<&'a [u8], FttsqError>

The byte span of one tensor within bytes.

Errors

Returns FttsqError::UnknownSection when the tensor’s section is missing, or FttsqError::RangeOutOfBounds when the resolved span leaves the buffer.

pub fn page_in_plan(&self) -> Vec<(&SectionEntry, PagePolicy)>

The page-in plan: every section paired with its policy, in the order to apply them.

Ordered PagePolicy::Resident first. Prefetch order matters under memory pressure — the section that gets its MADV_WILLNEED in last is the one most likely to find the page cache already full, and that must never be the microdecoder pack.

Within the resident group, smaller sections come first: the ~110 MB microdecoder pack lands ahead of the ~440 MB talker, so the reread-15×-per-frame working set wins the race for cache it would otherwise lose to a body read once per frame.

pub fn verify_census( &self, manifest: &ArtifactManifest, ) -> Result<(), Box<ArtifactCensus>>

Audits the artifact’s tensor directory against an expected inventory.

Errors

Returns the itemized ArtifactCensus when anything is missing, extra, or mis-declared.

Trait Implementations

impl Clone for FttsqReader

fn clone(&self) -> FttsqReader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FttsqReader

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

Formats the value using the given formatter.