Crate git_prole

Expand description

git-prole is a git worktree manager.

The git-prole Rust library is a convenience and shouldn’t be depended on. I do not consider this to be a public/stable API and will make breaking changes here in minor version bumps. If you’d like a stable git-prole Rust API for some reason, let me know and we can maybe work something out.

Modules§

fs: Like fs_err, but the functions are instrumented with tracing::instrument and return miette::Result instead of std::io::Result.

Structs§

AddWorktreeOpts: Options for git worktree add.
App
AppGit: A Git with borrowed Config.
CommitHash: A Git commit hash.
Config: Configuration, both from the command-line and a user configuration file.
Git: git CLI wrapper.
GitBranch: Git methods for dealing with worktrees.
GitConfig: Git methods for dealing with config.
GitPath: Git methods for dealing with paths.
GitRefs: Git methods for dealing with refs.
GitRemote: Git methods for dealing with remotes.
GitStatus: Git methods for dealing with statuses and the working tree.
GitWorktree: Git methods for dealing with worktrees.
LocalBranchRef: A Git reference to a local branch.
Ref: A Git reference.
RemoteBranchRef: A Git reference to a remote branch.
RenamedWorktree: A worktree with a new name.
ResolveUniqueNameOpts: Options for GitWorktree::resolve_unique_names.
Status: A git status listing.
StatusEntry: The status of a particular file.
Utf8TempDir
Worktree: A Git worktree.
Worktrees: A set of Git worktrees.

Enums§

BranchRef: A Git reference to a remote branch.
HeadKind: Is HEAD detached?
ResolvedCommitish: A resolved <commit-ish>, which can either be a commit hash or a ref name.
StatusCode: The status code of a particular file. Each StatusEntry has two of these.
WorktreeHead

Traits§

GitLike
PathDisplay: A way to display a path “nicely”.

Functions§