Struct magoo::git::GitContext

pub struct GitContext { /* private fields */ }

Context for running git commands

Implementations

impl GitContext

Implementation for basic operations

pub fn try_from<S>(working_dir: S) -> Result<Self, GitError>

where S: AsRef<Path>,

Create a new GitContext for running git commands in the given working directory

pub fn lock(&self) -> Result<Guard, GitError>

Return a guard that locks the repository until dropped. Other magoo processes cannot access the repository while the guard is alive.

pub fn print_version_info(&self) -> Result<(), GitError>

Print the supported git version info and current git version into

pub fn git_dir(&self) -> Result<&PathBuf, GitError>

Get the absolute path to the .git directory

pub fn git_dir_raw(&self) -> Result<Option<String>, GitError>

Return the raw output of git rev-parse --git-dir

pub fn top_level_dir(&self) -> Result<&PathBuf, GitError>

Get the absolute path to the top level directory

pub fn get_top_level_switch(&self) -> Result<Option<String>, GitError>

Get the path in git -C <path> ... to run the command in the top level directory

impl GitContext

Wrapper implementation for git commands

pub fn status(&self) -> Result<(), GitError>

Run git status and print the status

pub fn ls_files(&self, extra_args: &[&str]) -> Result<Vec<String>, GitError>

Run git -C top_level ls-files ...

pub fn describe(&self, commit: &str) -> Option<String>

Run git describe --all <commit> and return the first output

pub fn head(&self) -> Result<Option<String>, GitError>

Run git rev-parse HEAD

pub fn get_config<S>( &self, config_path: S, key: &str ) -> Result<Option<String>, GitError>

where S: AsRef<Path>,

Run git config -f config_path --get key

The config path is resolved relative to the working directory of this context.

pub fn get_config_regexp<S>( &self, config_path: S, regexp: &str ) -> Result<Vec<(String, String)>, GitError>

where S: AsRef<Path>,

Calls git config -f config_path ... --get-regexp regexp to get (key, value) pairs in the config file

The config path is resolved relative to the working directory of this context.

pub fn set_config<S>( &self, config_path: S, key: &str, value: Option<&str> ) -> Result<(), GitError>

where S: AsRef<Path>,

Calls git config to set or remove a config from a config file.

The config path is resolved relative to the working directory of this context.

pub fn remove_config_section<S>( &self, config_path: S, section: &str ) -> Result<(), GitError>

where S: AsRef<Path>,

Remove a config section from a config file.

The config path is resolved relative to the working directory of this context.

pub fn remove_from_index(&self, path: &str) -> Result<(), GitError>

Remove an object from the index and stage the change. The path should be relative from repo top level

pub fn add(&self, path: &str) -> Result<(), GitError>

Run git add

pub fn submodule_deinit( &self, path: Option<&str>, force: bool ) -> Result<(), GitError>

Runs git submodule deinit [-- <path>]. Path should be from top level

pub fn submodule_init(&self, path: Option<&str>) -> Result<(), GitError>

Runs git submodule init [-- <path>]. Path should be from top level

pub fn submodule_sync(&self, path: Option<&str>) -> Result<(), GitError>

Runs git submodule sync [-- <path>]. Path should be from top level

pub fn submodule_set_branch( &self, path: &str, branch: Option<&str> ) -> Result<(), GitError>

Runs git submodule set-branch. Path should be from top level

Note: Pre git 2.43, there’s a bug treating the argument as name instead of path.

pub fn submodule_set_url(&self, path: &str, url: &str) -> Result<(), GitError>

Runs git submodule set-url.

Note: Pre git 2.43, there’s a bug treating the argument as name instead of path.

pub fn submodule_update( &self, path: Option<&str>, force: bool, remote: bool ) -> Result<(), GitError>

Runs git submodule update [-- <path>]. Path should be from top level

pub fn submodule_add( &self, url: &str, path: Option<&str>, branch: Option<&str>, name: Option<&str>, depth: Option<usize>, force: bool ) -> Result<(), GitError>

Runs git submodule add. Path should be from top level