Skip to main content

Crate use_git_revision

Crate use_git_revision 

Source
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.
RevisionRange
A revision range such as A..B or A...B.

Enums§

RevisionParseError
Error returned while parsing revision vocabulary.
RevisionRangeKind
Revision range spelling.
RevisionSelector
A revision selector classification.
RevisionSuffix
A revision suffix such as ^ or ~2.