Module branchless::git

Tools for interfacing with the Git repository.

Structs

Branch

Represents a Git branch.

CherryPickFastOptions

Options for Repo::cherry_pick_fast.

Commit

Represents a commit object in the Git object database.

Config

Wrapper around the config values stored on disk for Git.

ConfigValue

A wrapper around a possible value that can be set for a config key.

Dag

Interface to access the directed acyclic graph (DAG) representing Git’s commit graph. Based on the Eden SCM DAG.

Diff

A diff between two trees/commits.

GitRunInfo

Path to the git executable on disk to be executed.

GitVersion

The parsed version of Git.

NonZeroOid

Represents the ID of a Git object.

PatchId

A checksum of the diff induced by a given commit, used for duplicate commit detection.

Reference

Represents a reference to an object.

Repo

Wrapper around git2::Repository.

RepoReferencesSnapshot

A snapshot of all the positions of references we care about in the repository.

ResolvedReferenceInfo

A snapshot of information about a certain reference. Updates to the reference after this value is obtained are not reflected.

Tree

A tree object. Contains a mapping from name to OID.

Enums

CategorizedReferenceName

Determine what kind of branch a reference is, given its name. The returned suffix value is converted to a String to be rendered to the screen, so it may have lost some information if the reference name had unusual characters.

CherryPickFastError

An error raised when attempting the Repo::cherry_pick_fast operation.

MaybeZeroOid

Represents an OID which may be zero or non-zero. This exists because Git often represents the absence of an object using the zero OID. We want to statically check for those cases by using a more descriptive type.

ReferenceTarget

The target of a reference.

ResolveCommitsResult

The result of attempting to resolve commits.

Traits

ConfigRead

Read-only interface to Git’s configuration.

ConfigWrite

Write-only interface to Git’s configuration.

Functions

commit_set_to_vec

Eagerly convert a CommitSet into a Vec<NonZeroOid> by iterating over it.

resolve_commits

Parse strings which refer to commits, such as:

sort_commit_set

Sort the given set of commits topologically. In the case of two commits being unorderable, sort them using a deterministic tie-breaking function. Commits which have been garbage collected and are no longer available in the repository are omitted.

Type Definitions

CommitSet

A compact set of commits, backed by the Eden DAG.

CommitVertex

A vertex referring to a single commit in the Eden DAG.