Enum radicle_surf::Branch

pub enum Branch {
    Local(Local),
    Remote(Remote),
}

A Branch represents any git branch. It can be Local or Remote.

Note that if a Branch is created from a git2::Reference then any refs/namespaces will be stripped.

Variants

Local(Local)

Remote(Remote)

Implementations

impl Branch

pub fn local<R>(name: R) -> Self

where R: AsRef<RefStr>,

Construct a Local branch.

pub fn remote<R>(remote: Component<'_>, name: R) -> Self

where R: AsRef<RefStr>,

Construct a Remote branch. The remote is the remote name of the reference name while the name is the suffix, i.e. refs/remotes/<remote>/<name>.

pub fn short_name(&self) -> &RefString

Return the short Branch refname, e.g. fix/ref-format.

pub fn refname(&self) -> Qualified<'_>

Give back the fully qualified Branch refname, e.g. refs/remotes/origin/fix/ref-format, refs/heads/fix/ref-format.

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 FromStr for Branch

type Err = Branch

The associated error which can be returned from parsing.

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

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

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

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 + PartialOrd,

Restrict a value to a certain interval.

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 PartialOrd for Branch

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

type Error = Error

fn object_id(&self, repo: &Repository) -> Result<Oid, Self::Error>

Returns the object id of this revision in repo.

impl TryFrom<&Reference<'_>> for Branch

type Error = Branch

The type returned in the event of a conversion error.

fn try_from(reference: &Reference<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for Branch

type Error = Branch

The type returned in the event of a conversion error.

fn try_from(name: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Branch

impl StructuralPartialEq for Branch