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/*, andrefs/remotes/*vocabulary. - Validate simple ref-name text.
- Keep repository lookup and dereferencing out of scope.
Structs§
- GitRef
- A concrete ref wrapper.
- GitRef
Name - A validated ref name.
- Symbolic
Ref - A symbolic ref target.
Enums§
- GitHead
- A lightweight
HEADvocabulary value. - GitRef
Kind - A broad ref-name kind.
- GitRef
Parse Error - Error returned while parsing ref vocabulary.