Struct Git2Context 

pub struct Git2Context { /* private fields */ }

Git context provider backed by git2.

Implementations

impl Git2Context

pub fn new(repo_path: &Path) -> Result<Self, AstDocError>

Open a git repository at the given path.

Errors

Returns an error if the path is not a git repository.

Trait Implementations

impl Debug for Git2Context

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

Formats the value using the given formatter.

impl GitContextProvider for Git2Context

fn get_branch(&self) -> Result<String, AstDocError>

Get the current branch name.

fn get_latest_commit(&self) -> Result<String, AstDocError>

Get the latest commit summary (short hash + subject).

fn get_diff(&self) -> Result<Option<String>, AstDocError>

Get the uncommitted diff as a string, or None if clean.

fn extract(&self) -> Result<GitContext, AstDocError>

Extract all git context into a GitContext struct.