Skip to main content

BranchOps

Struct BranchOps 

Source
pub struct BranchOps<'a> { /* private fields */ }
Available on crate feature workflow only.
Expand description

Operations on local branches, scoped to a Repository.

Obtained via Repository::branches. The handle borrows the repository for the duration of one chained call — there is no shared state.

Implementations§

Source§

impl<'a> BranchOps<'a>

Source

pub async fn list(&self) -> Result<Vec<Branch>>

List every local branch.

Source

pub async fn list_matching( &self, pattern: impl Into<String>, ) -> Result<Vec<Branch>>

List branches whose ref path matches pattern (a fnmatch-style glob applied to the full ref, e.g. "refs/heads/feature/*"). For short-name matching, pass "refs/heads/<glob>".

Source

pub async fn delete_merged(&self, into: impl AsRef<str>) -> Result<Vec<String>>

Delete every local branch fully merged into into (other than into itself and the current branch). Returns the deleted branch names.

Source

pub async fn rename( &self, from: impl Into<String>, to: impl Into<String>, ) -> Result<()>

Rename a branch (git branch -m <from> <to>).

Trait Implementations§

Source§

impl<'a> Debug for BranchOps<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for BranchOps<'a>

§

impl<'a> RefUnwindSafe for BranchOps<'a>

§

impl<'a> Send for BranchOps<'a>

§

impl<'a> Sync for BranchOps<'a>

§

impl<'a> Unpin for BranchOps<'a>

§

impl<'a> UnsafeUnpin for BranchOps<'a>

§

impl<'a> UnwindSafe for BranchOps<'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more