Struct branchless::git::Repo

pub struct Repo { /* fields omitted */ }

Wrapper around git2::Repository.

Implementations

impl Repo

pub fn from_dir(path: &Path) -> Result<Self>

Get the Git repository associated with the given directory.

pub fn from_current_dir() -> Result<Self>

Get the Git repository associated with the current directory.

pub fn try_clone(&self) -> Result<Self>

Open a new copy of the repository.

pub fn get_path(&self) -> &Path

Get the path to the .git directory for the repository.

pub fn get_rebase_state_dir_path(&self) -> PathBuf

Get the path to the directory inside the .git directory which contains state used for the current rebase (if any).

pub fn get_working_copy_path(&self) -> Option<&Path>

Get the path to the working copy for this repository. If the repository is bare (has no working copy), returns None.

pub fn get_config(&self) -> Result<Config>

Get the configuration object for the repository.

pub fn get_db_conn(&self) -> Result<Connection>

Get the connection to the SQLite database for this repository.

pub fn get_head_info(&self) -> Result<HeadInfo>

Get the OID for the repository’s HEAD reference.

pub fn set_head(&self, oid: NonZeroOid) -> Result<()>

Set the HEAD reference directly to the provided oid. Does not touch the working copy.

pub fn detach_head(&self, head_info: &HeadInfo) -> Result<()>

Detach HEAD by making it point directly to its current OID, rather than to a branch. If HEAD is already detached, logs a warning.

pub fn get_main_branch_reference(&self) -> Result<Reference<'_>>

Get the Reference for the main branch for the repository.

pub fn get_main_branch_oid(&self) -> Result<NonZeroOid>

Get the OID corresponding to the main branch.

pub fn get_branch_oid_to_names(
    &self
) -> Result<HashMap<NonZeroOid, HashSet<OsString>>>

Get a mapping from OID to the names of branches which point to that OID.

The returned branch names include the refs/heads/ prefix, so it must be stripped if desired.

pub fn is_rebase_underway(&self) -> Result<bool>

Detect if an interactive rebase has started but not completed.

Git will send us spurious post-rewrite events marked as amend during an interactive rebase, indicating that some of the commits have been rewritten as part of the rebase plan, but not all of them. This function attempts to detect when an interactive rebase is underway, and if the current post-rewrite event is spurious.

There are two practical issues for users as a result of this Git behavior:

• During an interactive rebase, we may see many “processing 1 rewritten commit” messages, and then a final “processing X rewritten commits” message once the rebase has concluded. This is potentially confusing for users, since the operation logically only rewrote the commits once, but we displayed the message multiple times.

• During an interactive rebase, we may warn about abandoned commits, when the next operation in the rebase plan fixes up the abandoned commit. This can happen even if no conflict occurred and the rebase completed successfully without any user intervention.

pub fn get_current_operation_type(&self) -> Option<&str>

Get the type current multi-step operation (such as rebase or cherry-pick) which is underway. Returns None if there is no such operation.

pub fn find_merge_base(
    &self,
    lhs: NonZeroOid,
    rhs: NonZeroOid
) -> Result<Option<NonZeroOid>>

Find the merge-base between two commits. Returns None if a merge-base could not be found.

pub fn get_paths_touched_by_commit(
    &self,
    effects: &Effects,
    commit: &Commit<'_>
) -> Result<Option<HashSet<PathBuf>>>

Get the file paths which were added, removed, or changed by the given commit.

pub fn get_patch_id(
    &self,
    effects: &Effects,
    commit: &Commit<'_>
) -> Result<Option<PatchId>>

Get the patch ID for this commit.

pub fn revparse_single_commit(&self, spec: &str) -> Result<Option<Commit<'_>>>

Attempt to parse the user-provided object descriptor.

pub fn get_all_references(&self) -> Result<Vec<Reference<'_>>>

Find all references in the repository.

pub fn has_changed_files(
    &self,
    effects: &Effects,
    git_run_info: &GitRunInfo
) -> Result<bool>

Check if the repository has staged or unstaged changes. Untracked files are not included. This operation may take a while.

pub fn create_reference(
    &self,
    name: &OsStr,
    oid: NonZeroOid,
    force: bool,
    log_message: &str
) -> Result<Reference<'_>>

Create a new reference or update an existing one.

pub fn find_reference(&self, name: &OsStr) -> Result<Option<Reference<'_>>>

Look up a reference with the given name. Returns None if not found.

pub fn get_all_local_branches(&self) -> Result<Vec<Branch<'_>>>

Get all local branches in the repository.

pub fn find_branch(
    &self,
    name: &str,
    branch_type: BranchType
) -> Result<Option<Branch<'_>>>

Look up the branch with the given name. Returns None if not found.

pub fn create_branch(
    &self,
    name: &OsStr,
    target: &Commit<'_>,
    force: bool
) -> Result<Branch<'_>>

Create a new branch or update an existing branch.

pub fn find_commit(&self, oid: NonZeroOid) -> Result<Option<Commit<'_>>>

Look up a commit with the given OID. Returns None if not found.

pub fn friendly_describe_commit_from_oid(
    &self,
    oid: NonZeroOid
) -> Result<StyledString>

Look up the commit with the given OID and render a friendly description of it, or render an error message if not found.

pub fn create_commit(
    &self,
    update_ref: Option<&str>,
    author: &Signature<'_>,
    committer: &Signature<'_>,
    message: &str,
    tree: &Tree<'_>,
    parents: &[&Commit<'_>]
) -> Result<NonZeroOid>

Create a new commit.

pub fn cherrypick_commit(
    &self,
    cherrypick_commit: &Commit<'_>,
    our_commit: &Commit<'_>,
    mainline: u32
) -> Result<Index>

Cherry-pick a commit in memory and return the resulting index.

pub fn find_tree(&self, oid: NonZeroOid) -> Result<Option<Tree<'_>>>

Look up the tree with the given OID. Returns None if not found.

pub fn write_index_to_tree(&self, index: &mut Index) -> Result<NonZeroOid>

Write the provided in-memory index as a tree into Git`s object database. There must be no merge conflicts in the index.

Trait Implementations

impl Debug for Repo

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

Formats the value using the given formatter.