Struct Branch 

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

A validated git branch name.

Branch names follow git’s reference naming rules:

• Cannot be empty
• Cannot start with -, ., or /
• Cannot end with /, ., or .lock
• Cannot contain .., //, @{, or control characters
• Cannot contain spaces or forbidden characters: ~^:?*[\
• Cannot be single @
• No component can start with . or end with .lock

Implementations

impl Branch

pub fn as_str(&self) -> &str

Returns the branch name as a string slice.

pub fn has_parents(&self) -> bool

Returns true if the branch name contains path separators.

pub const fn from_static_or_panic(input: &'static str) -> Self

Creates a branch name from a static string, panicking if invalid.

This is useful for compile-time constants.

Trait Implementations

impl AsRef<OsStr> for Branch

fn as_ref(&self) -> &OsStr

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Branch

fn clone(&self) -> Branch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Branch

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

Formats the value using the given formatter.

impl Display for Branch

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

Formats the value using the given formatter.

impl FromStr for Branch

type Err = BranchError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Branch

fn eq(&self, other: &Branch) -> 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 Eq for Branch

impl StructuralPartialEq for Branch