Struct Branch

pub struct Branch<'repo> { /* private fields */ }

Represents a Git branch.

Implementations

impl<'repo> Branch<'repo>

pub fn get_oid(&self) -> Result<Option<NonZeroOid>>

Get the OID pointed to by the branch. Returns None if the branch is not a direct reference (which is unusual).

pub fn get_name(&self) -> Result<&str>

Get the name of this branch, not including any refs/heads/ prefix. To get the full reference name of this branch, instead call .into_reference().get_name()?.

pub fn get_reference_name(&self) -> Result<ReferenceName>

Get the full reference name of this branch, including the refs/heads/ or refs/remotes/ prefix, as appropriate

pub fn get_upstream_branch(&self) -> Result<Option<Branch<'repo>>>

If this branch tracks a remote (“upstream”) branch, return that branch.

pub fn get_upstream_branch_target(&self) -> Result<Option<NonZeroOid>>

If this branch tracks a remote (“upstream”) branch, return the OID of the commit which that branch points to.

pub fn get_upstream_branch_name_without_push_remote_name( &self, ) -> Result<Option<String>>

If this branch tracks a remote (“upstream”) branch, return the name of that branch without the leading remote name. For example, if the upstream branch is origin/main, this will return main. (Usually, this is the same as the name of the local branch, but not always.)

pub fn get_push_remote_name(&self) -> Result<Option<String>>

Get the associated remote to push to for this branch. If there is no associated remote, returns None. Note that this never reads the value of push.remoteDefault.

pub fn into_reference(self) -> Reference<'repo>

Convert the branch into its underlying Reference.

pub fn rename(&mut self, new_name: &str, force: bool) -> Result<()>

Rename the branch. The new name should not start with refs/heads.

pub fn delete(&mut self) -> Result<()>

Delete the branch.

Trait Implementations

impl Debug for Branch<'_>

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

Formats the value using the given formatter.