Skip to main content

BranchManager

Struct BranchManager 

Source
pub struct BranchManager<'a> { /* private fields */ }
Expand description

Manager for repository branches

Provides operations similar to git branch commands.

§Examples

ⓘ
let repo = registry.repo(repo_id)?;
let branch_mgr = repo.branch();

// List branches
for branch in branch_mgr.list().await? {
    let marker = if branch.is_head { "*" } else { " " };
    println!("{} {}", marker, branch.name);
}

// Get current branch
if let Some(current) = branch_mgr.current().await? {
    println!("On branch: {}", current.name);
}

// Create new branch
branch_mgr.create("feature", Some("main")).await?;

// Checkout branch
branch_mgr.checkout("feature").await?;

// Remove branch
branch_mgr.remove("old-feature", false).await?;

Implementations§

Source§

impl<'a> BranchManager<'a>

Source

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

List all branches (local and remote)

Similar to git branch -a

Source

pub async fn current(&self) -> Git2DBResult<Option<Branch>>

Get the current branch (HEAD)

Returns None if HEAD is detached

Source

pub async fn create<R: IntoGitRef>( &self, name: &str, from: Option<R>, ) -> Git2DBResult<()>

Create a new branch

Similar to git branch <name> [from]

Accepts strings, GitRef enums, or direct Oids for the base reference. If from is None, creates from HEAD.

§Examples
ⓘ
// Create from HEAD
repo.branch().create("feature", None).await?;

// Create from string reference
repo.branch().create("feature", Some("main")).await?;

// Create from explicit GitRef
repo.branch().create("hotfix", Some(git2db::GitRef::Tag("v1.0.0".into()))).await?;

// Create from specific commit (type-safe)
let oid = git2::Oid::from_str("abc123...")?;
repo.branch().create("from-commit", Some(oid)).await?;
Source

pub async fn checkout(&self, name: &str) -> Git2DBResult<()>

Checkout a branch

Similar to git checkout <name>

Source

pub async fn remove(&self, name: &str, force: bool) -> Git2DBResult<()>

Remove a branch

Similar to git branch -d <name> (or -D if force=true)

Source

pub async fn rename( &self, old_name: Option<&str>, new_name: &str, ) -> Git2DBResult<()>

Rename current branch or a specific branch

Similar to git branch -m [old] <new>

Trait Implementations§

Source§

impl<'a> RepositoryAccessor for BranchManager<'a>

Source§

fn registry(&self) -> &Git2DB

Get the registry reference
Source§

fn repo_id(&self) -> &RepoId

Get the repository ID
Source§

fn repo_path(&self) -> Git2DBResult<PathBuf>

Get the repository worktree path
Source§

fn open_repo( &self, ) -> impl Future<Output = Git2DBResult<Repository>> + Send + '_
where Self: Sync,

Open the git repository (async, uses spawn_blocking) Read more

Auto Trait Implementations§

§

impl<'a> Freeze for BranchManager<'a>

§

impl<'a> !RefUnwindSafe for BranchManager<'a>

§

impl<'a> Send for BranchManager<'a>

§

impl<'a> Sync for BranchManager<'a>

§

impl<'a> Unpin for BranchManager<'a>

§

impl<'a> UnsafeUnpin for BranchManager<'a>

§

impl<'a> !UnwindSafe for BranchManager<'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
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

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.

§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

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

§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> MaybeSync for T
where T: Sync,