Skip to main content

CloneBuilder

Struct CloneBuilder 

Source
pub struct CloneBuilder { /* private fields */ }
Expand description

Builder for cloning repositories with fluent configuration.

Manages locks internally for minimal lock duration:

  • Brief read lock for configuration (base_dir, existing repo check)
  • No lock during network clone (the slow part)
  • Brief write lock for final registration

§Examples

use git2db::Git2DB;
use std::sync::Arc;
use tokio::sync::RwLock;

let registry = Arc::new(RwLock::new(Git2DB::open("/models").await?));

// Basic clone
let id = git2db::CloneBuilder::new(Arc::clone(&registry), "https://github.com/user/repo.git")
    .exec()
    .await?;

// Clone with configuration
let id = git2db::CloneBuilder::new(Arc::clone(&registry), "https://github.com/user/repo.git")
    .name("my-repo")
    .branch("develop")
    .depth(1)
    .exec()
    .await?;

Implementations§

Source§

impl CloneBuilder

Source

pub fn new(registry: Arc<RwLock<Git2DB>>, url: impl Into<String>) -> Self

Create a new clone builder.

Source

pub fn name(self, name: impl Into<String>) -> Self

Set a custom name for the repository

If not specified, a UUID will be used.

Source

pub fn branch(self, branch: impl Into<String>) -> Self

Checkout a specific branch

Similar to git clone --branch <name>

Source

pub fn tag(self, tag: impl Into<String>) -> Self

Checkout a specific tag

Similar to git clone --branch <tag>

Source

pub fn commit(self, oid: Oid) -> Self

Checkout a specific commit

Source

pub fn revspec(self, spec: impl Into<String>) -> Self

Checkout a specific revspec

Can be branch, tag, commit hash, or complex expressions like HEAD~3

Source

pub fn remote(self, name: impl Into<String>, url: impl Into<String>) -> Self

Add an additional remote

The primary URL becomes “origin”. Additional remotes are configured after cloning. Supports gittorrent:// URLs.

§Examples
ⓘ
CloneBuilder::new(Arc::clone(&registry), "https://github.com/user/repo.git")
    .remote("backup", "https://backup.com/repo.git")
    .remote("p2p", "gittorrent://peer/repo")
    .exec()
    .await?;
Source

pub fn depth(self, depth: u32) -> Self

Create a shallow clone with specific depth

Similar to git clone --depth <n>

Source

pub fn callback_config(self, config: CallbackConfig) -> Self

Set callback configuration for progress reporting and authentication

This allows custom progress callbacks during clone operations.

§Example
ⓘ
use git2db::callback_config::{CallbackConfig, ProgressConfig, ProgressReporter};
use std::sync::Arc;

struct MyReporter;
impl ProgressReporter for MyReporter {
    fn report(&self, stage: &str, current: usize, total: usize) {
        println!("{}: {}/{}", stage, current, total);
    }
}

let config = CallbackConfig::new()
    .with_progress(ProgressConfig::Channel(Arc::new(MyReporter)));

CloneBuilder::new(Arc::clone(&registry), "https://github.com/user/repo.git")
    .callback_config(config)
    .exec()
    .await?;
Source

pub async fn exec(self) -> Git2DBResult<RepoId>

Execute the clone operation with minimal lock duration.

Lock strategy:

  1. Read lock: Get config (base_dir, check existing, storage driver)
  2. No lock: Perform network clone (the slow part)
  3. Write lock: Register repository

Auto Trait Implementations§

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,