Crate gguf_rs_lib 

GGUF - A Rust library for GGUF file format

This library provides support for reading, writing, and manipulating GGUF (GGML Universal Format) files, commonly used for storing large language models.

Basic Usage

Creating a GGUF file

// Create a simple GGUF file
let builder = GGUFBuilder::simple("my_model", "A test model")
    .add_metadata("version", MetadataValue::String("1.0".to_string()))
    .add_f32_tensor("weights", vec![2, 2], vec![1.0, 2.0, 3.0, 4.0])?;

let (bytes, result) = builder.build_to_bytes()?;
println!("Created GGUF file with {} bytes", bytes.len());

Reading a GGUF file

let data = example_data();
let reader = GGUFFileReader::new(Cursor::new(data))?;

println!("GGUF version: {}", reader.header().version);
println!("Metadata entries: {}", reader.metadata().len());
println!("Tensors: {}", reader.tensor_count());

Re-exports

pub use error::GGUFError;

pub use error::Result;

Modules

async

Header-only async preview support for GGUF files.

builder

High-level builder pattern APIs for creating GGUF files

error

Error types for the GGUF library

format

GGUF v3 format structures and raw I/O primitives

metadata

Canonical GGUF metadata types.

mmap

Memory mapping support for GGUF files

prelude

reader

GGUF file reader functionality

tensor

Tensor descriptors, raw storage, shapes, and quantization geometry

writer

GGUF file writer functionality