Struct ModelFolder 

pub struct ModelFolder { /* private fields */ }

A folder that holds models, each in a folder of its own.

use std::sync::atomic::AtomicBool;
use ravenrs_ai::{LocalModel, ModelFamily, ModelFile, ModelFolder};

const MODEL: LocalModel = LocalModel {
    id: "tiny",
    name: "Tiny",
    license: "MIT",
    family: ModelFamily::Qwen3,
    memory: 2_000_000_000,
    understood: None,
    files: &[ModelFile {
        name: "tiny.gguf",
        url: "https://example.invalid/tiny.gguf",
        bytes: 1024,
        sha256: "0000000000000000000000000000000000000000000000000000000000000000",
    }],
};
let folder = ModelFolder::new("models");
folder.download(&MODEL, &|received, total| println!("{received} of {total}"), &AtomicBool::new(false))?;
folder.remove(&MODEL)?;

Implementations

impl ModelFolder

pub fn new(root: impl Into<PathBuf>) -> Self

A folder at root. It is created when something is downloaded.

pub fn root(&self) -> &Path

Where it is.

pub fn path_of(&self, model: &LocalModel, file: &ModelFile) -> PathBuf

Where a file of model is, or would be.

pub fn state(&self, model: &LocalModel) -> ModelState

Where model stands. Quick: it compares sizes, as the hash was checked when it arrived.

pub fn download( &self, model: &LocalModel, progress: &dyn Fn(u64, u64), cancelled: &AtomicBool, ) -> Result<(), ModelError>

Downloads what is missing of model and installs each file only if its hash is right. It blocks until the end, so call it away from the UI thread.

progress gets the bytes received and the total, and cancelled is looked at between chunks.

Errors

Why it did not arrive. Files already checked stay, so trying again goes on from there, and the one being downloaded is erased.

pub fn remove(&self, model: &LocalModel) -> Result<(), ModelError>

Removes everything of model, including a download left halfway.

Errors

When the disk refuses. A model that is not there is not an error.

Trait Implementations

impl Clone for ModelFolder

fn clone(&self) -> ModelFolder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelFolder

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

Formats the value using the given formatter.

impl Eq for ModelFolder

impl PartialEq for ModelFolder

fn eq(&self, other: &ModelFolder) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ModelFolder