Enum Branch 

pub enum Branch {
    Local {
        name: String,
        committer_email: String,
        committer_date_time: Timestamp,
    },
    Remote {
        name: String,
        committer_email: String,
        committer_date_time: Timestamp,
    },
}

Local or remote branch with metadata about the last commit.

Variants

Local

Local branch (under refs/heads/).

Fields

name: String

The name of the branch (without refs/heads/ or refs/remotes/ prefix).

committer_email: String

The email address of the last committer.

committer_date_time: Timestamp

The date and time when the last commit was made.

Remote

Remote tracking branch (under refs/remotes/).

Fields

name: String

The name of the branch (without refs/heads/ or refs/remotes/ prefix).

committer_email: String

The email address of the last committer.

committer_date_time: Timestamp

The date and time when the last commit was made.

Implementations

impl Branch

pub fn name(&self) -> &str

Returns the branch name (no “refs/” prefix).

pub fn name_no_origin(&self) -> &str

Returns the branch name with the “origin/” prefix removed if present.

pub fn committer_email(&self) -> &str

Returns the email address of the last committer on this branch.

pub const fn committer_date_time(&self) -> &Timestamp

Returns the timestamp of the last commit on this 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<'a> TryFrom<(Branch<'a>, BranchType)> for Branch

Attempts to convert a libgit2 branch and its type into our Branch enum.

Extracts the branch name, last committer email and date from the raw branch.

Errors

• Branch name is not valid UTF-8.
• Resolving the branch tip commit fails.
• Committer email is not valid UTF-8.
• Converting the committer timestamp into a [Timestamp] fails.

type Error = Report

The type returned in the event of a conversion error.

fn try_from( (raw_branch, branch_type): (Branch<'a>, BranchType), ) -> Result<Self, Self::Error>

Performs the conversion.