Skip to main content

GitManager

Struct GitManager 

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

Centralized Git manager with thread-safe operations

Implementations§

Source§

impl GitManager

Source

pub fn new(config: Git2DBConfig) -> Self

Create a new GitManager with the given configuration

Source

pub fn init_with_config(config: Git2DBConfig) -> Result<(), Git2DBError>

Initialize the global GitManager with a custom configuration

This must be called before the first call to global(). Subsequent calls will return an error to avoid silent configuration changes.

Returns Ok(()) if initialization succeeded, Err if it failed or already initialized.

§Example
use git2db::config::Git2DBConfig;
use git2db::GitManager;

let config = Git2DBConfig::default();
GitManager::init_with_config(config)?;
Source

pub fn global() -> &'static GitManager

Get the global GitManager instance

If not already initialized via init_with_config(), this will initialize it with default configuration.

Source

pub fn config(&self) -> &Git2DBConfig

Get the configuration for this GitManager

Source

pub fn default_clone_options(&self) -> CloneOptions

Create default clone options based on configuration

Source

pub fn is_initialized() -> bool

Check if the global GitManager has been initialized

Source

pub fn validate_path(&self, base_dir: &Path, path: &Path) -> Result<PathBuf>

Validate path for security (prevents directory traversal)

Source

pub fn get_repository<P: AsRef<Path>>( &self, path: P, ) -> Git2DBResult<RepositoryCache>

Get a repository cache handle with intelligent caching

Returns a RepositoryCache that tracks metadata and provides fresh Repository instances on each .open() call (for thread safety with git2).

Source

pub fn cache_stats(&self) -> CacheStats

Get repository cache statistics

Source

pub fn clear_cache(&self)

Clear the entire repository cache

Source

pub fn cleanup_cache(&self)

Manually trigger cache cleanup (remove expired entries)

Source

pub async fn clone_repository( &self, url: &str, target_path: &Path, options: Option<CloneOptions>, ) -> Git2DBResult<Repository>

Clone a repository with Send-safe async support

Uses spawn_blocking internally to handle git2 operations safely.

§Example
ⓘ
use git2db::clone_options::CloneOptions;
use git2db::callback_config::{CallbackConfigBuilder, ProgressConfig};
use git2db::auth::AuthStrategy;

let options = CloneOptions::builder()
    .callback_config(
        CallbackConfigBuilder::new()
            .auth(AuthStrategy::SshAgent { username: Some("git".to_owned()) })
            .progress(ProgressConfig::Stdout)
            .build()
    )
    .shallow(true)
    .depth(1)
    .build();

let repo = manager.clone_repository(url, path, Some(options)).await?;
Source

pub fn create_signature( &self, name: Option<&str>, email: Option<&str>, ) -> Git2DBResult<Signature<'static>>

Create a signature for commits

Source

pub fn remove_worktree( &self, base_repo_path: &Path, worktree_name: &str, base_dir: Option<&Path>, ) -> Git2DBResult<()>

Remove a worktree with cleanup

Source

pub fn list_worktrees(&self, repo_path: &Path) -> Git2DBResult<Vec<String>>

List all worktrees for a repository

Source

pub fn active_operations(&self) -> Vec<(String, Duration)>

Get statistics about cached paths Get active operations

Source

pub fn register_transport( &self, scheme: &str, factory: Arc<dyn TransportFactory>, ) -> Result<(), Git2DBError>

Register a custom transport for a URL scheme

This allows integration with custom git transports like gittorrent://, ipfs://, s3://, or any other custom protocol using a thread-safe registry.

§Example
use git2db::GitManager;

let manager = GitManager::new(Default::default());
let factory = Arc::new(MyTransportFactory);
manager.register_transport("custom", factory).unwrap();
Source

pub fn unregister_transport( &self, scheme: &str, ) -> Option<Arc<dyn TransportFactory>>

Unregister a custom transport

Returns the factory if it was registered, None otherwise. Uses reference counting for thread-safe cleanup.

Source

pub fn has_transport(&self, scheme: &str) -> bool

Check if a custom transport is registered for a given scheme

Source

pub fn registered_transports(&self) -> Vec<String>

Get a list of all registered transport schemes

Source

pub fn transport_stats(&self) -> RegistryStats

Get transport registry statistics

Source

pub fn driver_registry(&self) -> &Arc<DriverRegistry> ⓘ

Get the driver registry

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,