Struct Branch 

pub struct Branch { /* private fields */ }

Represents a Git branch.

A branch is a named reference that points to a commit. The branch name does not include the refs/heads/ prefix.

Implementations

impl Branch

pub fn new(name: impl Into<String>, oid: Oid) -> Self

Creates a new Branch.

Arguments

• name - The branch name (without refs/heads/ prefix).
• oid - The commit OID the branch points to.

pub fn current(name: impl Into<String>, oid: Oid) -> Self

Creates a new Branch marked as current.

Arguments

• name - The branch name (without refs/heads/ prefix).
• oid - The commit OID the branch points to.

pub fn name(&self) -> &str

Returns the branch name.

pub fn oid(&self) -> &Oid

Returns the commit OID the branch points to.

pub fn is_current(&self) -> bool

Returns true if this is the current branch.

pub fn reference_name(&self) -> String

Returns the full reference name (with refs/heads/ prefix).

pub fn short_oid(&self) -> String

Returns a short representation of the commit OID (7 characters).

pub fn set_current(&mut self, is_current: bool)

Sets whether this branch is the current branch.

Trait Implementations

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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