Crate git_prole

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

• PathDisplay
  A way to display a path “nicely”.

Functions

• format_bulleted_list
  Format an iterator of items into a bulleted list with line breaks between elements.
• format_bulleted_list_multiline
  Like format_bulleted_list, except the second and subsequent lines of multi-line items are indented as well.
• only_paths_in_parent_directory
  Check if a set of paths all have the same parent directory and they are the only paths in that directory (other than dotfiles).
• repository_url_destination
  Where will url be cloned to?