quickcfg 0.6.3

Do basic configuration of a system, declaratively and quickly.
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

//! Git abstraction.

use anyhow::Error;
use std::fmt;
use std::path::Path;

#[cfg(not(feature = "git2"))]
#[path = "git/external.rs"]
mod system;
#[cfg(feature = "git2")]
#[path = "git/git2.rs"]
mod system;

pub trait Git: Send + fmt::Debug {
    /// The path this git instance is associated with.
    fn path(&self) -> &Path;

    /// Check if repo needs to be updated.
    fn needs_update(&self) -> Result<bool, Error>;

    /// Check if the local repository has not been modified without comitting.
    fn is_fresh(&self) -> Result<bool, Error>;

    /// Force update repo.
    fn force_update(&self) -> Result<(), Error>;

    /// Update repo.
    fn update(&self) -> Result<(), Error>;
}

pub trait GitSystem: Send + Sync {
    fn test(&self) -> Result<bool, Error> {
        Ok(true)
    }

    /// Clone the given path.
    fn clone(&self, url: &str, path: &Path) -> Result<Box<dyn Git>, Error>;

    /// Open the given repository.
    fn open(&self, path: &Path) -> Result<Box<dyn Git>, Error>;
}

/// Open the given path.
pub fn setup() -> Result<Box<dyn GitSystem>, Error> {
    Ok(Box::new(system::GitSystem::new()))
}