Struct Repository 

pub struct Repository { /* private fields */ }

A handle to a git working tree.

Construction does not spawn git. Repository::open only verifies that a .git directory (or file, for worktrees/submodules) exists at the path.

Implementations

impl Repository

pub fn open(path: impl Into<PathBuf>) -> Result<Self>

Open an existing repository at path without running git.

Returns Error::NotARepository if path/.git does not exist.

pub fn new_unchecked(path: impl Into<PathBuf>) -> Self

Construct a Repository for path without checking that it exists.

Use this when you are about to run init or clone into the path.

pub fn path(&self) -> &Path

Working-tree path.

pub fn git_dir(&self) -> PathBuf

Path to the .git directory (or file) inside the working tree.

pub async fn init(path: impl Into<PathBuf>) -> Result<Self>

Initialize a new repository at path.

Equivalent to git init <path>. Returns the created Repository.

pub async fn clone( url: impl Into<String>, path: impl Into<PathBuf>, ) -> Result<Self>

Clone url into path.

pub fn add(&self) -> AddCommand

Build an AddCommand scoped to this repository.

pub fn commit(&self) -> CommitCommand

Build a CommitCommand scoped to this repository.

pub fn status(&self) -> StatusCommand

Build a StatusCommand scoped to this repository.

pub fn log(&self) -> LogCommand

Build a LogCommand scoped to this repository.

pub fn diff(&self) -> DiffCommand

Build a DiffCommand scoped to this repository.

pub fn show(&self) -> ShowCommand

Build a ShowCommand scoped to this repository.

pub fn branch(&self) -> BranchCommand

Build a BranchCommand scoped to this repository.

pub fn checkout(&self) -> CheckoutCommand

Build a CheckoutCommand scoped to this repository.

pub fn switch(&self) -> SwitchCommand

Build a SwitchCommand scoped to this repository.

pub fn merge(&self) -> MergeCommand

Build a MergeCommand scoped to this repository.

pub fn rebase(&self) -> RebaseCommand

Build a RebaseCommand scoped to this repository.

pub fn pull(&self) -> PullCommand

Build a PullCommand scoped to this repository.

pub fn push(&self) -> PushCommand

Build a PushCommand scoped to this repository.

pub fn fetch(&self) -> FetchCommand

Build a FetchCommand scoped to this repository.

pub fn remote(&self, action: RemoteCommand) -> RemoteCommand

Build a RemoteCommand scoped to this repository.

pub fn tag(&self) -> TagCommand

Build a TagCommand scoped to this repository.

pub fn stash(&self, action: StashCommand) -> StashCommand

Build a StashCommand scoped to this repository.

pub fn reset(&self) -> ResetCommand

Build a ResetCommand scoped to this repository.

pub fn restore(&self) -> RestoreCommand

Build a RestoreCommand scoped to this repository.

pub fn rm(&self) -> RmCommand

Build an RmCommand scoped to this repository.

pub fn mv(&self, src: impl Into<String>, dst: impl Into<String>) -> MvCommand

Build an MvCommand scoped to this repository.

pub fn cherry_pick(&self) -> CherryPickCommand

Build a CherryPickCommand scoped to this repository.

pub fn grep(&self, pattern: impl Into<String>) -> GrepCommand

Build a GrepCommand scoped to this repository with the given pattern.

pub fn config(&self, action: ConfigCommand) -> ConfigCommand

Build a ConfigCommand scoped to this repository.

pub fn reflog(&self, action: ReflogCommand) -> ReflogCommand

Build a ReflogCommand scoped to this repository.

pub fn worktree(&self, action: WorktreeCommand) -> WorktreeCommand

Build a WorktreeCommand scoped to this repository.

pub fn submodule(&self, action: SubmoduleCommand) -> SubmoduleCommand

Build a SubmoduleCommand scoped to this repository.

pub fn bisect(&self, action: BisectCommand) -> BisectCommand

Build a BisectCommand scoped to this repository.

impl Repository

pub fn branches(&self) -> BranchOps<'_>

Available on crate feature workflow only.

Operations on local branches.

impl Repository

pub fn history(&self) -> HistoryWalk<'_>

Available on crate feature workflow only.

Walk commit history with a chained-builder filter.

impl Repository

pub async fn info(&self) -> Result<RepoInfo>

Available on crate feature workflow only.

Collect a RepoInfo snapshot in a single call.

Runs git status --porcelain=v2 --branch plus one symbolic-ref lookup for the default branch. See the module docs for details and caveats.

impl Repository

pub fn tags(&self) -> TagOps<'_>

Available on crate feature workflow only.

Operations on tags.

impl Repository

pub fn workflow(&self) -> WorkflowOps<'_>

Available on crate feature workflow only.

High-level workflow compositions.

Trait Implementations

impl Clone for Repository

fn clone(&self) -> Repository

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Repository

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

Formats the value using the given formatter.