Struct BranchName 

pub struct BranchName(/* private fields */);

A branch name git would accept for refs/heads/, whose components are therefore safe directory names.

Implementations

impl BranchName

pub fn parse(name: &str) -> Result<Self>

Validate a branch name by git’s reference rules, offline.

use majordomus_cli::worktree::BranchName;
assert!(BranchName::parse("feature/improve-cli").is_ok());
assert!(BranchName::parse("feature/providers/openai-streaming").is_ok());
assert!(BranchName::parse("žluťoučký/kůň").is_ok());
for bad in ["", "/", "a/", "/a", "a//b", "a/../b", "..", ".hidden", "a/.b", "a.lock",
            "a b", "a~b", "a^b", "a:b", "a?b", "a*b", "a[b", "a\\b", "a@{b", "-x",
            "a.", "a/b.lock/c", "a\u{7f}b", "a\nb"] {
    assert!(BranchName::parse(bad).is_err(), "{bad:?} should be refused");
}

pub fn as_str(&self) -> &str

The name.

pub fn relative_path(&self) -> PathBuf

The relative path under the container: the name’s components, one directory each.

use majordomus_cli::worktree::BranchName;
use std::path::PathBuf;
let b = BranchName::parse("fix/cockpit/reconnect").unwrap();
assert_eq!(b.relative_path(), PathBuf::from("fix/cockpit/reconnect"));

pub fn components(&self) -> impl Iterator<Item = &str>

The components, in order.

Trait Implementations

impl Clone for BranchName

fn clone(&self) -> BranchName

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BranchName

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for BranchName

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for BranchName

impl Hash for BranchName

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BranchName

fn cmp(&self, other: &BranchName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BranchName

fn eq(&self, other: &BranchName) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BranchName

fn partial_cmp(&self, other: &BranchName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for BranchName