Struct GgufFile 

pub struct GgufFile { /* private fields */ }

A live two-namespace GGUF container.

Array keys can be enumerated, while the current C ABI does not expose metadata-key enumeration. The handle is intentionally non-cloneable and thread-affine.

use mlx_rs::io::GgufFile;

let file = GgufFile::new()?;
assert!(file.array_keys()?.is_empty());

Implementations

impl GgufFile

pub fn new() -> Result<Self, GgufError>

Creates an empty GGUF container.

pub fn load(path: impl AsRef<Path>) -> Result<Self, GgufError>

Loads a GGUF file on the thread-local stream, falling back to CPU.

use mlx_rs::io::GgufFile;

let file = GgufFile::load("model.gguf")?;
println!("{} tensors", file.array_keys()?.len());

pub fn save(&self, path: impl AsRef<Path>) -> Result<(), GgufError>

Saves the container to a .gguf path.

Saving evaluates contained arrays and may allocate row-major materializations. It uses the GGUF writer directly and does not consult the ambient Rust stream.

use mlx_rs::{io::GgufFile, Array};

let mut file = GgufFile::new()?;
file.insert_array("weight", &Array::from_f32(1.0))?;
file.save("model.gguf")?;

pub fn array_keys(&self) -> Result<Vec<String>, GgufError>

Returns array keys in deterministic lexical order.

pub fn get_array(&self, key: &str) -> Result<Option<Array>, GgufError>

Returns a new independently owned MLX array handle for key.

pub fn arrays(&self) -> Result<HashMap<String, Array>, GgufError>

Copies the array namespace into independently owned MLX handles.

pub fn insert_array( &mut self, key: impl AsRef<str>, value: &Array, ) -> Result<(), GgufError>

Inserts an array, rejecting duplicate keys and unsupported writer dtypes.

pub fn metadata_kind( &self, key: &str, ) -> Result<Option<GgufMetadataKind>, GgufError>

Returns the kind of a metadata value, or None when the key is absent.

pub fn get_metadata( &self, key: &str, ) -> Result<Option<GgufMetadataValue>, GgufError>

Returns a metadata value, or None when the key is absent.

pub fn get_metadata_array(&self, key: &str) -> Result<Option<Array>, GgufError>

Returns array metadata, or None when the key is absent.

pub fn get_metadata_string( &self, key: &str, ) -> Result<Option<String>, GgufError>

Returns string metadata, or None when the key is absent.

pub fn get_metadata_strings( &self, key: &str, ) -> Result<Option<Vec<String>>, GgufError>

Returns string-list metadata, or None when the key is absent.

pub fn insert_metadata<V>( &mut self, key: impl AsRef<str>, value: V, ) -> Result<(), GgufError>

where V: Into<GgufMetadataValue>,

Inserts metadata, rejecting duplicate keys and unsupported metadata arrays.

Trait Implementations

impl Debug for GgufFile

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

Formats the value using the given formatter.