Struct radicle_surf::vcs::git::Branch

pub struct Branch {
    pub name: BranchName,
    pub locality: BranchType,
}

The combination of a branch's name and where its locality (remote or local).

Note: The PartialOrd and Ord implementations compare on BranchName only.

Fields

name: BranchName

locality: BranchType

Methods

impl Branch

pub fn remote(name: BranchName) -> Self

Helper to create a remote Branch with a name

pub fn local(name: BranchName) -> Self

Helper to create a remote Branch with a name

Trait Implementations

impl Clone for Branch

fn clone(&self) -> Branch

Returns a copy 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 Eq for Branch

impl Ord for Branch

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Branch> for Branch

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Branch> for Branch

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Branch

impl StructuralPartialEq for Branch