summaryrefslogtreecommitdiffstats
path: root/asyncgit/README.md
blob: 492773ca29cbf04744c3beb70e0ed2654a73340e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
# asyncgit

*allow using git2 in an asynchronous context*

This crate is designed as part of the [gitui](http://gitui.org) project.

`asyncgit` provides the primary interface to interact with *git* repositories. It is split into the main module and a `sync` part. The latter provides convenience wrapper for typical usage patterns against git repositories.

The primary goal however is to allow putting certain (potentially) long running [git2](https://github.com/rust-lang/git2-rs) calls onto a thread pool.[crossbeam-channel](https://github.com/crossbeam-rs/crossbeam) is then used to wait for a notification confirming the result. 

In `gitui` this allows the main-thread and therefore the *ui* to stay responsive.