Expand description
§use-git-revision
Primitive Git revision selector vocabulary for RustUse.
use-git-revision models revision selectors, suffixes, and ranges such as A..B and A...B. It does not resolve revisions.
§Basic usage
use use_git_revision::{GitRevision, RevisionRange, RevisionRangeKind};
let revision = GitRevision::head();
let range = RevisionRange::new("main", "feature/use-git", RevisionRangeKind::TwoDot)
.expect("valid range");
assert_eq!(revision.as_str(), "HEAD");
assert_eq!(range.to_string(), "main..feature/use-git");§Scope
- Model
HEAD, branch, tag, ref, and object identifier selectors as text. - Model parent and ancestor suffix vocabulary.
- Keep revision resolution out of scope.
Structs§
- GitRevision
- A lightweight revision selector text.
- Revision
Range - A revision range such as
A..BorA...B.
Enums§
- Revision
Parse Error - Error returned while parsing revision vocabulary.
- Revision
Range Kind - Revision range spelling.
- Revision
Selector - A revision selector classification.
- Revision
Suffix - A revision suffix such as
^or~2.