Struct GitContext 

pub struct GitContext {
    pub project_id: Option<String>,
    pub branch: Option<String>,
    pub file_path: Option<String>,
}

Git repository context information.

Provides project identification, branch name, and optional file context derived from a git repository. All fields are optional to handle non-git directories and edge cases gracefully.

Examples

use subcog::context::GitContext;

let ctx = GitContext::from_cwd();
match (&ctx.project_id, &ctx.branch) {
    (Some(project), Some(branch)) => {
        println!("Working on {project} @ {branch}");
    }
    (Some(project), None) => {
        println!("Working on {project} (detached HEAD)");
    }
    (None, _) => {
        println!("Not in a git repository");
    }
}

Fields

project_id: Option<String>

Project identifier derived from git remote URL or repository directory name.

Format: org/repo from remote URL, or just the directory name if no remote. Credentials are stripped from URLs for security.

branch: Option<String>

Current branch name.

None if in detached HEAD state or if HEAD is unborn (empty repository).

file_path: Option<String>

Optional file path context.

Can be set to provide file-specific context for operations.

Implementations

impl GitContext

pub fn from_cwd() -> Self

Detects git context from the current working directory.

Uses git2::Repository::discover() to find the repository root, traversing parent directories if necessary.

Returns

A GitContext with detected values. If not in a git repository, all fields will be None.

Examples

use subcog::context::GitContext;

let ctx = GitContext::from_cwd();
if ctx.project_id.is_some() {
    println!("In a git repository");
}

pub fn from_path(path: &Path) -> Self

Detects git context from a specific path.

Uses git2::Repository::discover() to find the repository containing the given path, traversing parent directories if necessary.

Arguments

• path - The path to detect context from. Can be any path within a repository.

Returns

A GitContext with detected values. If the path is not in a git repository, all fields will be None.

Examples

use subcog::context::GitContext;
use std::path::Path;

let ctx = GitContext::from_path(Path::new("/path/to/repo/subdir"));
println!("Project: {:?}", ctx.project_id);

pub fn with_file_path(self, file_path: impl Into<String>) -> Self

Creates a new GitContext with the specified file path.

This is useful for adding file-specific context to an existing detection.

Arguments

• file_path - The file path to associate with this context.

Examples

use subcog::context::GitContext;

let ctx = GitContext::from_cwd()
    .with_file_path("src/main.rs");

pub const fn is_git_repo(&self) -> bool

Returns true if this context represents a git repository.

A context is considered to be in a git repository if it has a project ID.

pub const fn is_detached(&self) -> bool

Returns true if the repository is in detached HEAD state.

Returns false if not in a git repository.

Trait Implementations

impl Clone for GitContext

fn clone(&self) -> GitContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitContext

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

Formats the value using the given formatter.

impl Default for GitContext

fn default() -> GitContext

Returns the “default value” for a type.

impl PartialEq for GitContext

fn eq(&self, other: &GitContext) -> 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 GitContext

impl StructuralPartialEq for GitContext