Skip to main content

Crate use_git_ref

Crate use_git_ref 

Source
Expand description

§use-git-ref

Primitive Git ref vocabulary for RustUse.

use-git-ref models ref names, ref kinds, symbolic refs, and HEAD. It does not dereference refs or inspect repositories.

§Basic usage

use use_git_ref::{GitHead, GitRefKind, GitRefName};

let name = GitRefName::new("refs/heads/main").expect("valid ref");
let head = GitHead::symbolic(name.clone());

assert_eq!(name.kind(), GitRefKind::Branch);
assert!(head.is_symbolic());

§Scope

  • Recognize HEAD, refs/heads/*, refs/tags/*, and refs/remotes/* vocabulary.
  • Validate simple ref-name text.
  • Keep repository lookup and dereferencing out of scope.

Structs§

GitRef
A concrete ref wrapper.
GitRefName
A validated ref name.
SymbolicRef
A symbolic ref target.

Enums§

GitHead
A lightweight HEAD vocabulary value.
GitRefKind
A broad ref-name kind.
GitRefParseError
Error returned while parsing ref vocabulary.