Struct git2::Branch

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

A structure to represent a git branch

A branch is currently just a wrapper to an underlying Reference. The reference can be accessed through the get and into_reference methods.

Implementations

impl<'repo> Branch<'repo>

pub fn wrap(reference: Reference<'_>) -> Branch<'_>

Creates Branch type from a Reference

pub fn name_is_valid(name: &str) -> Result<bool, Error>

Ensure the branch name is well-formed.

pub fn get(&self) -> &Reference<'repo>

Gain access to the reference that is this branch

pub fn get_mut(&mut self) -> &mut Reference<'repo>

Gain mutable access to the reference that is this branch

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

Take ownership of the underlying reference.

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

Delete an existing branch reference.

pub fn is_head(&self) -> bool

Determine if the current local branch is pointed at by HEAD.

pub fn rename(
    &mut self,
    new_branch_name: &str,
    force: bool
) -> Result<Branch<'repo>, Error>

Move/rename an existing local branch reference.

pub fn name(&self) -> Result<Option<&str>, Error>

Return the name of the given local or remote branch.

May return Ok(None) if the name is not valid utf-8.

pub fn name_bytes(&self) -> Result<&[u8], Error>

Return the name of the given local or remote branch.

pub fn upstream(&self) -> Result<Branch<'repo>, Error>

Return the reference supporting the remote tracking branch, given a local branch reference.

pub fn set_upstream(&mut self, upstream_name: Option<&str>) -> Result<(), Error>

Set the upstream configuration for a given local branch.

If None is specified, then the upstream branch is unset. The name provided is the name of the branch to set as upstream.