Crate git_stub_vcs 

VCS abstraction and materialization for git stubs.

A GitStub (e.g., foo.json.gitstub) contains a reference to a file stored in Git history, in the format commit:path. This crate provides a VCS abstraction for reading file contents from history, and helpers to materialize these references into actual files.

Usage in build scripts

// build.rs
use git_stub_vcs::Materializer;

fn main() {
    // repo_root is relative to CARGO_MANIFEST_DIR (the directory containing
    // this crate's Cargo.toml). Typically "." or some number of "..".
    let repo_root = "../..";
    let materializer = Materializer::for_build_script(repo_root)
        .expect("VCS detected at repo root");

    // git_stub_path is relative to repo_root.
    let spec_path = materializer
        .materialize("openapi/my-api/my-api-1.0.0-abc123.json.gitstub")
        .expect("materialized successfully");

    // spec_path is a path in OUT_DIR with the materialized content.
    // The materializer also emits cargo::rerun-if-changed for the git stub.
}

Usage outside build scripts

use git_stub_vcs::Materializer;

// repo_root is relative to the current working directory.
let materializer = Materializer::standard("../..", "/tmp/output")
    .expect("VCS detected at repo root");

// git_stub_path is relative to repo_root.
let spec_path = materializer
    .materialize("openapi/my-api/my-api-1.0.0-abc123.json.gitstub")
    .expect("materialized successfully");

Structs

Materializer

Materializes git stubs into actual file content.

Vcs

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

Enums

AtomicWriteError

An error that occurred during an atomic file write.

MaterializeError

Errors that can occur during git stub materialization.

ReadContentsError

An error that occurs while reading the contents of a GitStub.

ShallowCloneError

An error that occurs while checking for a shallow clone.

VcsDetectError

An error that occurs during VCS detection.

VcsEnvError

An error from reading a VCS binary path from the environment.

VcsName

The name of a version control system.