git-meta 0.6.0

A basic git repo metadata inspection tool
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

use std::collections::HashMap;
use std::path::PathBuf;

use chrono::prelude::*;
use git_url_parse::GitUrl;

/// `GitCredentials` holds authentication information for a remote git repository
#[derive(Clone, Debug, PartialEq)]
pub enum GitCredentials {
    SshKey {
        username: String,
        public_key: Option<PathBuf>,
        private_key: PathBuf,
        passphrase: Option<String>,
    },
    UserPassPlaintext {
        username: String,
        password: String,
    },
}

/// Use `GitRepo::open()` to read a repo on disk. `GitRepo::new()` if you need to clone the repo.
///
/// Use `GitRepoCloneRequest` to clone repo to disk
///
#[derive(Clone, Debug, Default, PartialEq)]
pub struct GitRepo {
    /// The remote url of the repo
    pub url: GitUrl,
    /// The current commit. This can be configured prior to clone with `with_commit()`
    pub head: Option<GitCommitMeta>,
    /// The ssh key or user/pass needed to clone for private repo
    pub credentials: Option<GitCredentials>,
    /// The name of the remote branch.
    /// This can be configured with a local branch name prior to clone with `with_branch()`.
    pub branch: Option<String>,
    /// The location of the repo on disk
    pub path: Option<PathBuf>,
}

/// Represents request to clone repo to disk
///
/// After cloning, returns a `GitRepo`
///
/// Clone a repo with `.git_clone()` or `git_clone_shallow()`
#[derive(Clone, Debug, Default, PartialEq)]
pub struct GitRepoCloneRequest {
    /// The remote url of the repo
    pub url: GitUrl,
    /// The current commit. This can be configured prior to clone with `with_commit()`
    pub head: Option<GitCommitMeta>,
    /// The ssh key or user/pass needed to clone for private repo
    pub credentials: Option<GitCredentials>,
    /// The name of the remote branch.
    /// This can be configured with a local branch name prior to clone with `with_branch()`.
    pub branch: Option<String>,
    /// The location of the repo on disk
    pub path: Option<PathBuf>,
}

#[derive(Clone, Debug, Default, PartialEq)]
pub struct GitRepoInfo {
    /// The remote url of the repo
    pub url: GitUrl,
    /// The current commit. This can be configured prior to clone with `with_commit()`
    pub head: Option<GitCommitMeta>,
    /// The ssh key or user/pass needed to clone for private repo
    pub credentials: Option<GitCredentials>,
    /// The name of the remote branch.
    /// This can be configured with a local branch name prior to clone with `with_branch()`.
    pub branch: Option<String>,
    /// The location of the repo on disk
    pub path: Option<PathBuf>,
}

/// `GitCommitMeta` holds basic info about a single commit
#[derive(Clone, Debug, PartialEq)]
pub struct GitCommitMeta {
    /// The SHA-1 hash of the commit
    pub id: String,
    /// The commit message of the commit
    pub message: Option<String>,
    /// The timestamp of the commit in `Utc`
    pub timestamp: Option<DateTime<Utc>>,
}

pub type BranchHeads = HashMap<String, GitCommitMeta>;