Skip to main content

Branch

ytil_git::branch

Enum Branch

pub enum Branch {
    Local {
        name: String,
        committer_email: String,
        committer_date_time: DateTime<Utc>,
    },
    Remote {
        name: String,
        committer_email: String,
        committer_date_time: DateTime<Utc>,
    },
}

Expand description

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: DateTime<Utc>

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: DateTime<Utc>

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) -> &DateTime<Utc>

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. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for Branch

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

Formats the value using the given formatter. Read more

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 DateTime 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.

Auto Trait Implementations§

impl Freeze for Branch

impl RefUnwindSafe for Branch

impl Send for Branch

impl Sync for Branch

impl Unpin for Branch

impl UnsafeUnpin for Branch

impl UnwindSafe for Branch

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

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

impl<O> ObjectMarkerFor<Local> for O
where O: 'static,

fn run_creation_hooks(report: ReportMut<'_, Dynamic, Local>)

impl<O> ObjectMarkerFor<SendSync> for O
where O: 'static + Send + Sync,

fn run_creation_hooks(report: ReportMut<'_>)

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.