Struct Repository 

pub struct Repository { /* private fields */ }

Represents a Git repository

Implementations

impl Repository

pub fn new(path: impl AsRef<Path>) -> Result<Self, RepositoryError>

Creates a new Repository instance from a path

Errors

This function will return an error if:

• The provided path does not contain a .git directory

pub fn get_path(&self) -> &Path

Returns the path to the repository

pub fn list_pack_files(&self) -> Result<Vec<PathBuf>, RepositoryError>

Lists all pack files in the repository

Errors

This function will return an error if:

• File system operations fail when reading the objects/pack directory

pub fn list_pack_groups( &self, ) -> Result<HashMap<String, PackGroup>, RepositoryError>

Lists all pack-related files grouped by their base name (without extension)

Returns a map where keys are base names (e.g., “pack-abc123”) and values are structs containing paths to all related files (.pack, .idx, .rev, .mtimes)

Errors

This function will return an error if:

• File system operations fail when reading the objects/pack directory

pub fn list_head_refs(&self) -> Result<Vec<PathBuf>, RepositoryError>

Lists all head refs (local branches) in the repository

Errors

This function will return an error if:

• File system operations fail when reading the refs/heads directory

pub fn list_remote_refs( &self, ) -> Result<Vec<(String, Vec<PathBuf>)>, RepositoryError>

Lists all remote refs grouped by remote name

Errors

This function will return an error if:

• File system operations fail when reading the refs/remotes directory

pub fn list_tag_refs(&self) -> Result<Vec<PathBuf>, RepositoryError>

Lists all tag refs in the repository

Errors

This function will return an error if:

• File system operations fail when reading the refs/tags directory

pub fn has_stash_ref(&self) -> Result<bool, RepositoryError>

Checks if stash ref exists

Errors

This function will return an error if:

• File system operations fail when checking for stash refs

pub fn list_loose_objects( &self, limit: usize, ) -> Result<Vec<PathBuf>, RepositoryError>

Lists a sample of loose objects in the repository Limit parameter controls the maximum number of objects to return

Errors

This function will return an error if:

• File system operations fail when reading loose object directories

pub fn read_loose_object( &self, path: &Path, ) -> Result<LooseObject, RepositoryError>

Reads and parses a loose object from the given path

Errors

This function will return an error if:

• The file cannot be read
• The object cannot be decompressed or parsed

pub fn read_loose_object_by_hash( &self, hash: &str, ) -> Result<LooseObject, RepositoryError>

Reads and parses a loose object by its hash

Errors

This function will return an error if:

• The object file cannot be found or read
• The object cannot be decompressed or parsed

pub fn list_parsed_loose_objects( &self, limit: usize, ) -> Result<Vec<LooseObject>, RepositoryError>

List parsed loose objects with a limit

Errors

This function will return an error if:

• File system operations fail when reading loose object directories
• Objects cannot be parsed or decompressed

pub fn loose_object_exists(&self, hash: &str) -> bool

Check if a loose object exists by its hash

pub fn get_loose_object_stats( &self, ) -> Result<LooseObjectStats, RepositoryError>

Get statistics about all loose objects in the repository

Errors

This function will return an error if:

• File system operations fail when reading loose object directories
• Objects cannot be parsed or analyzed