Skip to main content

Crate use_git_branch

Crate use_git_branch 

Source
Expand description

§use-git-branch

Primitive Git branch name vocabulary for RustUse.

use-git-branch models local, remote-tracking, and default branch names. It offers small category helpers without enforcing a workflow.

§Basic usage

use use_git_branch::{DefaultBranchName, GitBranchName};

let branch = GitBranchName::new("feature/use-git").expect("valid branch");
let default_branch = DefaultBranchName::main();

assert!(branch.is_feature());
assert_eq!(default_branch.as_str(), "main");

§Scope

  • Validate basic branch-name text.
  • Classify common prefixes such as feature/, release/, and hotfix/.
  • Keep branch creation, checkout, and workflow policy out of scope.

Structs§

DefaultBranchName
A conventional default branch name.
GitBranchName
A validated branch name.
LocalBranchName
A local branch name.
RemoteTrackingBranchName
A remote-tracking branch spelling such as origin/main.

Enums§

GitBranchNameError
Error returned while parsing branch names.