Struct git2::Branch

source · []
pub struct Branch<'repo> { /* private fields */ }
Expand description

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

Creates Branch type from a Reference

Ensure the branch name is well-formed.

Gain access to the reference that is this branch

Gain mutable access to the reference that is this branch

Take ownership of the underlying reference.

Delete an existing branch reference.

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

Move/rename an existing local branch reference.

Return the name of the given local or remote branch.

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

Return the name of the given local or remote branch.

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

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.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.