Struct ModelIndex 

pub struct ModelIndex {
    pub(super) paths: Paths,
}

Persistent model references and artifact ownership under one storage root. Operations lock the catalog as needed; this handle does not retain artifact leases.

Fields

paths: Paths

Implementations

impl ModelIndex

pub(super) fn lock(&self) -> Result<LockedCatalog>

impl ModelIndex

pub fn add_disk_store( &self, name: &str, path: &Path, layout: DiskLayout, ) -> Result<DiskStore>

Register an existing filesystem root without crawling or importing models.

pub fn disk_stores(&self) -> Result<Vec<DiskStore>>

List store registrations without opening their roots or contacting providers.

pub fn set_disk_store_enabled(&self, name: &str, enabled: bool) -> Result<()>

Enable or disable resolution through a store’s URI without changing its ID.

pub fn remove_disk_store(&self, name: &str) -> Result<()>

Forget a store registration without deleting files or registered model entries.

impl ModelIndex

pub fn remove(&self, reference: &str, source_only: bool) -> Result<Removal>

Remove a model registration, or release only its retained source reference. Source-only removal first checks the prepared checkpoint. Files remain until Self::gc collects unreferenced owned artifacts; external files are untouched.

pub fn gc(&self, dry_run: bool) -> Result<GcReport>

Collect unreferenced catalog artifacts that have no active lease. Owned directories are deleted; external records are removed without deleting their files. A dry run reports candidates without removing either.

impl ModelIndex

pub fn pack( &self, reference: &str, request: PackOptions<'_>, ) -> Result<ModelDetails>

Prepare requested variants and atomically update the model’s artifact reference. Existing usable stores can be reused. Rebuilds leave previously leased stores unchanged. HF imports use a full local snapshot; newly downloaded sources are discarded after success unless retention was requested.

fn prepared_copy( &self, model: &ModelEntry, ) -> Result<Option<(Artifact, ArtifactLease)>>

fn metadata_repair( &self, model: &ModelEntry, previous: Option<&ArtifactLease>, ) -> Result<Option<ArtifactLease>>

Hold the source only when a prepared artifact needs missing metadata copied.

fn available_metadata( &self, model: &ModelEntry, ) -> Result<Option<ArtifactLease>>

Retain available source metadata without downloading another weight snapshot.

fn acquire_source( &self, model: &ModelEntry, token: Option<&str>, downloaded: &mut Option<Pending>, ) -> Result<ArtifactLease>

fn local_source_lease( &self, model: &ModelEntry, path: &Path, ) -> Result<ArtifactLease>

fn export(&self, pending: &Pending, path: &Path) -> Result<Artifact>

fn discard(&self, id: &str) -> Result<()>

impl ModelIndex

pub fn select( &self, input: &Path, options: ResolveOptions<'_>, ) -> Result<ModelDetails>

Resolve an alias, ID, URI, or explicit path; register unknown sources. Unqualified known HF URIs reuse their pinned entry without contacting HF.

fn select_disk( &self, name: &str, repo: &str, revision: Option<&str>, alias: Option<&str>, ) -> Result<ModelDetails>

Locate disk files only after lookup has ruled out an existing indexed identity.

fn name_existing( &self, model: ModelEntry, name: Option<&str>, ) -> Result<ModelDetails>

Assign an optional name through the normal collision and ownership checks.

impl ModelIndex

pub(super) fn artifact_root(&self, id: &str) -> PathBuf

pub(super) fn artifact_path(&self, artifact: &Artifact) -> PathBuf

pub(super) fn lease_file(&self, id: &str) -> Result<File>

pub(super) fn lease(&self, artifact: &Artifact) -> Result<ArtifactLease>

pub fn acquire_prepared(&self, reference: &str) -> Result<ArtifactLease>

Lease an existing, published prepared artifact without building or downloading. Fail if the model is unprepared or its artifact path is missing.

pub(super) fn begin(&self, kind: ArtifactKind) -> Result<Pending>

pub(super) fn publish( &self, model: &ModelEntry, pending: Artifact, retained: Option<Artifact>, ) -> Result<()>

impl ModelIndex

pub fn new(paths: Paths) -> Self

Select the index location without opening or creating it.

pub fn resolve(&self, reference: &str) -> Result<ModelEntry>

Look up a source reference, alias, or model ID and return its catalog entry. The returned metadata does not keep its artifacts alive.

pub fn add( &self, source: &str, revision: Option<&str>, name: Option<&str>, token: Option<&str>, ) -> Result<ModelDetails>

Register a local checkpoint path or an hf://owner/repo source. Hub registration pins a commit and reads metadata without downloading the full weights. revision defaults to main; it and token apply only to HF. Registration does not transfer file ownership. The same source reuses its ID.

fn add_local(&self, path: &Path, name: Option<&str>) -> Result<ModelDetails>

Inspect a local source and adopt existing prepared output without copying it.

fn register( &self, source: Source, description: ModelDescription, name: Option<&str>, prepared: Option<PathBuf>, ) -> Result<String>

fn adopt_prepared(&self, catalog: &mut Catalog, path: &Path) -> Result<String>

fn require_registered_location( &self, catalog: &Catalog, path: &Path, ) -> Result<()>

An exact managed entry reuses its ownership record. Other paths inside the artifact namespace cannot safely be recorded as external locations.

fn require_external_path(&self, canonical_path: &Path) -> Result<()>

fn artifact_at( &self, catalog: &Catalog, kind: ArtifactKind, path: &Path, ) -> Option<String>

Registering a managed path adds a reference to its existing ownership record.

pub fn list(&self) -> Result<Vec<ModelSummary>>

Summarize registered models and inspect their current artifact availability. An absent index returns an empty list without creating it.

pub fn show(&self, reference: &str) -> Result<ModelDetails>

Report a model’s source, preparation requirements, and referenced artifacts.

pub fn description(&self, reference: &str) -> Result<ModelDescription>

Inspect the referenced prepared artifact, or return registered source metadata. A recorded prepared artifact that is missing or unreadable returns an error.

fn details(&self, catalog: &Catalog, model: &ModelEntry) -> Result<ModelDetails>

Trait Implementations

impl Clone for ModelIndex

fn clone(&self) -> ModelIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.