gixor 0.5.2

An API for managing .gitignore files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

//! Git bridge module that abstracts over different Git backends.
//! Provides functions to interact with Git repositories
//! using either the `gix` crate or system Git commands
//! based on feature flags.
use crate::repos::Boilerplate;
use crate::Result;
use std::path::Path;

#[cfg(feature = "usegix")]
#[path = "gitbridge/gix.rs"]
mod gitctrl;

#[cfg(not(feature = "usegix"))]
#[path = "gitbridge/systemgit.rs"]
mod gitctrl;

/// Returns the latest commit hash (as bytes) of the repository at the given path.
pub fn pull(repository_path: &Path, remote_name: &str, branch_name: &str) -> Result<()> {
    gitctrl::pull(repository_path, remote_name, branch_name)
}

/// Clones the repository from the given URL to the specified destination path.
pub fn clone<S: AsRef<str>, P: AsRef<Path>>(url: S, dest_path: P) -> Result<()> {
    gitctrl::clone(url, dest_path)
}

/// Returns the latest commit hash (as bytes) of the given boilerplate in the repository located at base_path.
pub fn hash<P: AsRef<Path>>(boilerplate: &Boilerplate, base_path: P) -> Result<Vec<u8>> {
    gitctrl::hash(boilerplate, base_path)
}