use-git-ref 0.0.1

Primitive Git ref vocabulary for RustUse
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# 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

```rust
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.