Struct FttsqStreamPlan 

pub struct FttsqStreamPlan { /* private fields */ }

Metadata and fixed section lengths for a bounded .fttsq conversion.

A converter learns every tensor’s shape, storage policy, section, and final byte length from the validated input manifest before it starts payload conversion. That lets this plan reserve the directory first, then stream one section at a time into a caller-owned seekable temporary file. The writer never retains a payload section, and does not create, rename, or remove files: the caller owns the atomic-temp-file policy around it.

Implementations

impl FttsqStreamPlan

pub fn new( model_family: impl Into<String>, source_sha256: impl Into<String>, ) -> Self

Starts a bounded conversion plan for one model family and source checkpoint.

pub fn license_notice(self, notice: impl Into<String>) -> Self

Sets the required Apache-2.0 §4 attribution notice.

pub fn model_config(self, config: Value) -> Self

Attaches the frozen upstream model configuration.

pub fn quantization_manifest(self, manifest: Value) -> Self

Attaches the policy used to quantize each tensor.

pub fn section( self, name: impl Into<String>, access_class: AccessClass, length: u64, ) -> Self

Declares a section’s final byte length before its bytes are streamed.

pub fn tensor(self, tensor: TensorEntry) -> Self

Declares a tensor located in one of the planned sections.

pub fn begin<W: Write + Seek>( self, writer: W, ) -> Result<FttsqStreamingWriter<W>, FttsqError>

Writes the header and reserved directory into a caller-owned seekable stream.

Payload sections must subsequently be supplied in declaration order through FttsqStreamingWriter::write_section. A caller that needs an atomic artifact should provide its own same-filesystem temporary file, call FttsqStreamingWriter::finish, sync it, and rename it only after this method has finalized the directory.

Errors

Refuses malformed planned metadata before writing any bytes, and names I/O failures from the caller’s stream without assuming a path or filesystem policy.

Trait Implementations

impl Debug for FttsqStreamPlan

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

Formats the value using the given formatter.