Struct GitPlumber 

pub struct GitPlumber { /* private fields */ }

Main application struct that handles shared logic

Implementations

impl GitPlumber

pub fn new(repo_path: impl AsRef<Path>) -> Self

Create a new GitPlumber instance

pub fn get_repo_path(&self) -> &Path

Get the repository path

pub const fn get_repository(&self) -> Option<&Repository>

Get access to the repository if it exists

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

List all pack files in the repository

Errors

This function will return an error if:

• The path is not a valid git repository
• File system operations fail when reading the objects/pack directory

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

List all pack-related files grouped by their base name

Errors

This function will return an error if:

• The path is not a valid git repository
• File system operations fail when reading the objects/pack directory

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

List all head refs (local branches) in the repository

Errors

This function will return an error if:

• The path is not a valid git repository
• File system operations fail when reading the refs/heads directory

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

List all remote refs in the repository

Errors

This function will return an error if:

• The path is not a valid git repository
• File system operations fail when reading the refs/remotes directory

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

List all tag refs in the repository

Errors

This function will return an error if:

• The path is not a valid git repository
• File system operations fail when reading the refs/tags directory

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

Check if the repository has stash refs

Errors

This function will return an error if:

• The path is not a valid git repository
• File system operations fail when checking for stash refs

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

List loose objects in the repository with a limit

Errors

This function will return an error if:

• The path is not a valid git repository
• File system operations fail when reading loose object directories

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

List parsed loose objects in the repository with a limit

Errors

This function will return an error if:

• The path is not a valid git repository
• File system operations fail when reading loose object directories
• Loose objects cannot be parsed or decompressed

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

Get statistics about loose objects in the repository

Errors

This function will return an error if:

• The path is not a valid git repository
• File system operations fail when reading loose object directories
• Loose objects cannot be parsed or analyzed

pub fn parse_pack_file(&self, path: &Path) -> Result<(), String>

Parse a pack file (basic analysis)

Errors

This function will return an error if:

• The pack file cannot be read
• The pack file format is invalid
• Parsing operations fail

pub fn parse_pack_file_rich(&self, path: &Path) -> Result<(), String>

Parse a pack file with detailed formatting for display

Errors

This function will return an error if:

• The pack file cannot be read
• The pack file format is invalid
• Parsing or display formatting operations fail

pub fn view_file_as_object(&self, path: &Path) -> Result<(), String>

View a file as a loose object with rich formatting

Errors

This function will return an error if:

• The file cannot be read or parsed as a loose object
• The formatting operations fail

pub fn view_object_by_hash(&self, hash: &str) -> Result<(), String>

View an object by hash with rich formatting

Errors

This function will return an error if:

• The object cannot be found by hash
• Multiple objects match a partial hash (disambiguation needed)
• The formatting operations fail