rskit-git 0.2.0-alpha.1

Composable git repository interfaces backed by libgit2
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
88
89
90

//! Read-oriented git traits.

use rskit_errors::AppResult;

use crate::options::{BlameOptions, DescribeOptions, GrepOptions, LogOptions};
use crate::types::{
    BlameLine, Commit, DiffEntry, DiffStats, GrepMatch, IndexEntry, Oid, StatusEntry, TreeEntry,
    TreeHash,
};

/// Diff and working tree status operations.
pub trait Differ {
    /// Returns file changes between two refs.
    fn diff(&self, from: &str, to: &str) -> AppResult<Vec<DiffEntry>>;

    /// Returns aggregated statistics for changes between two refs.
    fn diff_stats(&self, from: &str, to: &str) -> AppResult<DiffStats>;

    /// Returns the working tree status.
    fn status(&self) -> AppResult<Vec<StatusEntry>>;
}

/// Read access to Git ignore rules.
pub trait IgnoreReader {
    /// Reports whether a repository-relative path is ignored by Git.
    ///
    /// The path does not need to exist in the working tree.
    fn is_ignored(&self, path: &str) -> AppResult<bool>;
}

/// Read access to git index entries.
pub trait IndexReader {
    /// Returns the index entry for `path`, if the path is present in the index.
    fn index_entry(&self, path: &str) -> AppResult<Option<IndexEntry>>;
}

/// Read access to git tree objects.
pub trait TreeReader {
    /// Returns the OID of the tree at the given path and revision.
    fn tree_hash(&self, revision: &str, path: &str) -> AppResult<TreeHash>;

    /// Returns the content of a file at the given revision and path.
    fn file_at(&self, revision: &str, path: &str) -> AppResult<Vec<u8>>;

    /// Returns the entries in a tree at the given revision and path.
    fn list_entries(&self, revision: &str, path: &str) -> AppResult<Vec<TreeEntry>>;
}

/// Read-only access to commit history and graph queries.
pub trait LogReader {
    /// Returns commits reachable from `HEAD`, filtered by the provided options.
    fn log(&self, opts: Option<&LogOptions>) -> AppResult<Vec<Commit>>;

    /// Returns the merge base between two revisions.
    fn merge_base(&self, a: &str, b: &str) -> AppResult<Oid>;

    /// Reports whether `ancestor` is an ancestor of `descendant`.
    fn is_ancestor(&self, ancestor: &str, descendant: &str) -> AppResult<bool>;
}

/// Read-only access to `git blame` data.
pub trait Blamer {
    /// Returns per-line blame information for a file at the given revision.
    fn blame(
        &self,
        revision: &str,
        path: &str,
        opts: Option<&BlameOptions>,
    ) -> AppResult<Vec<BlameLine>>;
}

/// Read-only advanced inspection helpers.
pub trait Inspector {
    /// Describes the current revision in a human-readable form.
    fn describe(&self, opts: Option<&DescribeOptions>) -> AppResult<String>;

    /// Resolves a revision expression to an object ID.
    fn rev_parse(&self, revision: &str) -> AppResult<Oid>;

    /// Searches tracked content for pattern matches.
    fn grep(
        &self,
        pattern: &str,
        revision: &str,
        opts: Option<&GrepOptions>,
    ) -> AppResult<Vec<GrepMatch>>;

    /// Returns raw object content for a revision expression.
    fn show(&self, object: &str) -> AppResult<Vec<u8>>;
}