Struct Vcs 

pub struct Vcs(/* private fields */);

The version control system used to read file contents from history.

Supports Git and Jujutsu (jj). Use Vcs::git(), Vcs::jj(), or Vcs::detect().

Implementations

impl Vcs

pub fn git() -> Result<Self, VcsEnvError>

Creates a Git VCS using the $GIT environment variable or "git".

Returns an error if the $GIT environment variable is set but is not valid UTF-8.

pub fn jj() -> Result<Self, VcsEnvError>

Creates a Jujutsu VCS using the $JJ environment variable or "jj".

Returns an error if the $JJ environment variable is set but is not valid UTF-8.

pub fn detect(repo_root: &Utf8Path) -> Result<Self, VcsDetectError>

Detects the appropriate VCS for a repository.

repo_root must be the repository root.

Detection order:

1. If a .jj path exists, returns jj (including colocated mode where both .jj and .git exist).
2. If a .git path exists, returns git. (.git may be a directory or a file, as in worktrees and submodules.)
3. Otherwise, returns an error.

pub fn binary(&self) -> &str

Returns the path to the VCS binary.

pub fn name(&self) -> VcsName

Returns the name of the VCS.

pub fn is_shallow_clone( &self, repo_root: &Utf8Path, ) -> Result<bool, ShallowCloneError>

Checks if the repository at repo_root is a shallow clone.

For Git, runs git rev-parse --is-shallow-repository. For Jujutsu, resolves the underlying Git store using jj git root --ignore-working-copy and checks for a shallow marker file there.

pub fn read_git_stub_contents( &self, stub: &GitStub, repo_root: &Utf8Path, ) -> Result<Vec<u8>, ReadContentsError>

Reads the contents of the file referenced by a git stub.

For Git, runs git cat-file blob <commit>:<path>. For Jujutsu, runs jj file show --revision <commit> <path>.

Trait Implementations

impl Clone for Vcs

fn clone(&self) -> Vcs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vcs

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

Formats the value using the given formatter.

impl PartialEq for Vcs

fn eq(&self, other: &Vcs) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Vcs

impl StructuralPartialEq for Vcs