grit_lib/
lib.rs

1//! Gust library — core Git-compatible engine.
2//!
3//! # Architecture
4//!
5//! All Git-compatible logic lives here; the `grit` binary is a thin CLI shim
6//! that parses arguments and delegates to types exposed from this crate.
7//!
8//! ## Where to start
9//!
10//! - [`Repository`](repo::Repository) is the central handle — open or discover
11//!   one, then reach the object store, index, refs, and config through it.
12//! - [`prelude`] re-exports the handful of types most call sites need.
13//! - [`porcelain`] holds user-facing operations that return structured result
14//!   *models* (the CLI renders them); [`plumbing`] holds the low-level,
15//!   machine-stable building blocks. The flat module list below remains the
16//!   low-level escape hatch and keeps every existing path valid.
17//! - Browse the engine by subsystem via the domain views: [`object_store`],
18//!   [`references`], [`worktree_index`], [`revision`], [`diffing`], [`merging`],
19//!   and [`configuration`].
20//! - [`progress`] defines how long-running operations report progress and
21//!   observe cancellation without touching the terminal.
22//!
23//! ## Core modules
24//!
25//! - [`error`] — shared error types using `thiserror`
26//! - [`objects`] — object ID, object kinds, and in-memory representations
27//! - [`odb`] — loose object store (read/write zlib-compressed objects)
28//! - [`repo`] — repository discovery and handle
29//! - [`index`] — Git index (staging area) read/write
30//! - [`ignore`] — ignore/exclude pattern matching for check-ignore
31//! - [`refs`] — reference storage (files backend)
32
33// --- Curated public API (additive; the flat `pub mod` list below is unchanged
34// so every existing `grit_lib::<module>::…` path keeps resolving) ---
35pub mod plumbing;
36pub mod porcelain;
37pub mod progress;
38
39/// The types most callers need, re-exported for `use grit_lib::prelude::*;`.
40pub mod prelude {
41    pub use crate::config::ConfigSet;
42    pub use crate::error::{Error, Result};
43    pub use crate::index::Index;
44    pub use crate::objects::{Object, ObjectId, ObjectKind};
45    pub use crate::odb::Odb;
46    pub use crate::repo::Repository;
47}
48
49// Domain-grouped views of the engine. Each is a curated table of contents over
50// the flat module list below — pure module re-exports, so `object_store::objects`
51// and the original `objects` path both resolve. A module appears in at most one
52// domain; cross-cutting and operation-level modules stay in the flat list.
53
54/// Object storage: ids/kinds, the object database, packs, multi-pack index, deltas.
55pub mod object_store {
56    pub use crate::{
57        delta_encode, delta_islands, midx, objects, odb, pack, pack_geometry, pack_name_hash,
58        pack_rev, promisor, promisor_remote, prune_packed, unpack_objects,
59    };
60}
61
62/// References: the refs backends, reflog, refspecs, name validation, namespaces.
63pub mod references {
64    pub use crate::{
65        branch_ref_format, branch_tracking, check_ref_format, hide_refs, ref_exclusions,
66        ref_namespace, reflog, refs, refspec, reftable,
67    };
68}
69
70/// Index and working tree: the index, sparse checkout, attributes, ignore, CRLF.
71pub mod worktree_index {
72    pub use crate::{
73        attributes, crlf, ignore, index, index_name_hash_lazy, path_walk, resolve_undo,
74        sparse_checkout, split_index, untracked_cache, worktree, worktree_cwd, worktree_ref,
75        write_tree,
76    };
77}
78
79/// Revision machinery: rev-parse, rev-list, name-rev, commit-graph.
80pub mod revision {
81    pub use crate::{commit_graph_file, commit_graph_write, name_rev, rev_list, rev_parse};
82}
83
84/// Diffing: tree/content diff, rename detection, diffstat, line-log, pickaxe bloom.
85pub mod diffing {
86    pub use crate::{
87        bloom, combined_diff_patch, combined_tree_diff, diff, diff_indent_heuristic, diff_moved,
88        diffstat, difftool, line_log, patch_ids, userdiff,
89    };
90}
91
92/// Merging: merge-base, tree/file merges, rerere, merge-message formatting.
93pub mod merging {
94    pub use crate::{
95        fmt_merge_msg, merge_base, merge_diff, merge_file, merge_tree_trivial, merge_trees,
96        mergetool_vimdiff, rerere,
97    };
98}
99
100/// Configuration and identity: config cascade, .gitmodules, author/committer idents.
101pub mod configuration {
102    pub use crate::{
103        config, dotfile, gitmodules, ident, ident_config, ident_resolve, precompose_config,
104        url_rewrite,
105    };
106}
107
108pub mod am;
109pub mod apply;
110pub mod attributes;
111pub mod blame;
112pub mod bloom;
113pub mod branch_ref_format;
114pub mod branch_tracking;
115pub mod check_ref_format;
116pub mod combined_diff_patch;
117pub mod combined_tree_diff;
118pub mod commit;
119pub mod commit_encoding;
120pub mod commit_graph_file;
121pub mod commit_graph_write;
122pub mod commit_pretty;
123pub mod commit_trailers;
124pub mod config;
125pub mod connectivity;
126pub mod credentials;
127pub mod crlf;
128pub mod delta_encode;
129pub mod delta_islands;
130pub mod diff;
131pub mod diff_indent_heuristic;
132pub mod diff_moved;
133pub mod diffstat;
134pub mod difftool;
135pub mod dotfile;
136pub mod error;
137mod ewah_bitmap;
138pub mod fast_export;
139pub mod fast_import;
140pub mod fetch;
141pub mod fetch_head;
142pub mod fetch_negotiator;
143pub mod fetch_submodules;
144pub mod filter_process;
145pub mod fmt_merge_msg;
146pub mod fsck_standalone;
147pub mod gc;
148pub mod git_binary_base85;
149pub mod git_column;
150pub mod git_date;
151pub mod git_path;
152pub mod gitmodules;
153pub mod hide_refs;
154pub mod hooks;
155pub mod ident;
156pub mod ident_config;
157pub mod ident_resolve;
158pub mod ignore;
159pub mod index;
160pub mod index_name_hash_lazy;
161pub mod interpret_trailers;
162pub mod line_log;
163pub mod ls_remote;
164pub mod mailinfo;
165pub mod mailmap;
166pub mod merge_base;
167pub mod merge_diff;
168pub mod merge_file;
169pub mod merge_tree_trivial;
170pub mod merge_trees;
171pub mod mergetool_vimdiff;
172pub mod midx;
173pub mod name_rev;
174pub mod net_trace;
175pub mod notes;
176pub mod objects;
177pub mod odb;
178pub mod pack;
179pub mod pack_geometry;
180pub mod pack_name_hash;
181pub mod pack_rev;
182#[cfg(feature = "test-tools")]
183pub mod parse_options_test_tool;
184pub mod patch_ids;
185pub mod path_walk;
186pub mod pathspec;
187pub mod pkt_line;
188pub mod precompose_config;
189pub mod promisor;
190pub mod promisor_remote;
191pub mod protocol;
192pub mod protocol_v2;
193pub mod prune_packed;
194pub mod push;
195pub mod push_cert;
196pub mod push_report;
197pub mod push_submodules;
198pub mod quote_path;
199pub mod receive_pack;
200pub mod ref_exclusions;
201pub mod ref_namespace;
202pub mod reflog;
203pub mod refs;
204pub mod refs_fsck;
205pub mod refspec;
206pub mod reftable;
207pub mod repo;
208pub mod rerere;
209pub mod resolve_undo;
210pub mod rev_list;
211pub mod rev_parse;
212pub mod shallow;
213pub mod shared_repo;
214pub mod signing;
215#[cfg(unix)]
216pub mod simple_ipc;
217pub mod sparse_checkout;
218pub mod split_index;
219pub mod unicode_normalization;
220pub mod untracked_cache;
221pub mod upload_filter;
222#[cfg(not(unix))]
223pub mod simple_ipc {
224    /// Whether simple IPC is supported on this platform.
225    #[must_use]
226    pub fn supports_simple_ipc() -> bool {
227        false
228    }
229
230    /// Stub for non-Unix targets.
231    pub fn run_simple_ipc_tool(_args: &[String]) -> i32 {
232        eprintln!("simple IPC not available on this platform");
233        1
234    }
235}
236pub mod state;
237pub mod stripspace;
238pub mod submodule_active;
239pub mod submodule_config;
240pub mod submodule_config_cache;
241pub mod submodule_gitdir;
242pub mod tab_expand;
243#[cfg(feature = "test-tools")]
244pub mod test_tool_progress;
245pub mod textconv_cache;
246pub mod transfer;
247pub mod transport;
248pub mod transport_path;
249pub mod tree_path_follow;
250#[cfg(unix)]
251pub mod unix_process;
252pub mod unpack_objects;
253pub mod url_rewrite;
254pub mod userdiff;
255pub mod whitespace_rule;
256pub mod wildmatch;
257pub mod worktree;
258pub mod worktree_cwd;
259pub mod worktree_ref;
260pub mod write_tree;
261pub mod ws;
grit_lib/lib.rs

grit_lib/
lib.rs
