Enum gix_ref::Category

pub enum Category<'a> {
    Tag,
    LocalBranch,
    RemoteBranch,
    Note,
    PseudoRef,
    MainPseudoRef,
    MainRef,
    LinkedPseudoRef {
        name: &'a BStr,
    },
    LinkedRef {
        name: &'a BStr,
    },
    Bisect,
    Rewritten,
    WorktreePrivate,
}

The various known categories of references.

This translates into a prefix containing all references of a given category.

Variants

Tag

A tag in refs/tags

LocalBranch

A branch in refs/heads

RemoteBranch

A branch in refs/remotes

Note

A tag in refs/notes

PseudoRef

Something outside of ref/ in the current worktree, typically HEAD.

MainPseudoRef

A PseudoRef, but referenced so that it will always refer to the main worktree by prefixing it with main-worktree/.

MainRef

Any reference that is prefixed with main-worktree/refs/

LinkedPseudoRef

A PseudoRef in another linked worktree, never in the main one, like worktrees/<id>/HEAD.

Fields

name: &'a BStr

The name of the worktree.

LinkedRef

Any reference that is prefixed with worktrees/<id>/refs/.

Fields

name: &'a BStr

The name of the worktree.

Bisect

A ref that is private to each worktree (linked or main), with refs/bisect/ prefix

Rewritten

A ref that is private to each worktree (linked or main), with refs/rewritten/ prefix

WorktreePrivate

A ref that is private to each worktree (linked or main), with refs/worktree/ prefix

Implementations

impl<'a> Category<'a>

pub fn prefix(&self) -> &BStr

Return the prefix that would contain all references of our kind, or an empty string if the reference would be directly inside of the git_dir().

pub fn is_worktree_private(&self) -> bool

Returns true if the category is private to their worktrees, and never shared with other worktrees.

Trait Implementations

impl<'a> Clone for Category<'a>

fn clone(&self) -> Category<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Category<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Category<'a>

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<'a> Ord for Category<'a>

fn cmp(&self, other: &Category<'a>) -> 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<'a> PartialEq for Category<'a>

fn eq(&self, other: &Category<'a>) -> bool

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

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

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

impl<'a> PartialOrd for Category<'a>

fn partial_cmp(&self, other: &Category<'a>) -> Option<Ordering>

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

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

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

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

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

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

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

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<'a> Copy for Category<'a>

impl<'a> Eq for Category<'a>

impl<'a> StructuralPartialEq for Category<'a>