Skip to main content

rustik_diff/
lib.rs

1//! Unified diff parsing and terminal-buffer viewing.
2//!
3//! The viewer is intentionally I/O-free: it parses or accepts patch data,
4//! owns read-only viewer state, and writes frames into a
5//! [`rustik_tui::Buffer`]. Backend access is abstracted behind the
6//! [`rustik_repo::DiffRepository`] trait so the viewer stays testable. The `rustik-diff`
7//! binary owns stdin/stdout, terminals, and events.
8//!
9//! The optional `builtins` feature (on by default) bundles default highlighting
10//! assets ([`Builtins`]) and a background worker ([`spawn_highlighter`]) so
11//! hosts get a batteries-included viewer; disable it to bring your own.
12#![deny(unsafe_code)]
13#![warn(missing_docs)]
14#![warn(clippy::unwrap_used)]
15
16#[cfg(feature = "builtins")]
17mod builtins;
18mod commit;
19mod context;
20mod decorate;
21mod document;
22mod highlight;
23#[cfg(feature = "builtins")]
24mod highlighter;
25mod status;
26mod viewer;
27mod word;
28
29pub mod decode;
30pub mod encode;
31
32#[cfg(feature = "builtins")]
33pub use builtins::Builtins;
34pub use commit::{CommitHeader, Header, ParseCommitError};
35pub use context::ContextChange;
36pub use decode::Decode;
37pub use decorate::{DiffDecorator, FileDecoration, HunkDecoration, ReviewProgress};
38pub use document::{
39    DecodeError, DiffDocument, DiffLine, DiffLineKind, FileDiff, FileHeader, FileId, FileKind,
40    FileMode, FileStats, Hunk, HunkHeader, HunkId, Oid, OidError, RowId, Stats,
41};
42pub use encode::Encode;
43pub use highlight::{
44    BuiltinHighlighter, DiffHighlighter, DiffSide, HighlightKey, HighlightKeyInput,
45    HighlightRequest, HighlightResult, HighlightSource,
46};
47#[cfg(feature = "builtins")]
48pub use highlighter::{HighlightOutput, Highlighter, spawn_highlighter};
49pub use status::{
50    REVIEW_PROGRESS_BAR_GLYPH, diffstat, file_count, progress_bar, recoverable_error,
51};
52pub use viewer::{
53    ContextRequest, ContextUpdate, DiffAction, DiffFocus, DiffOptions, DiffPalette, DiffState,
54    DiffViewer, FileTree, FileTreeMode, FileTreeTarget, HunkFocus, ViewChange,
55};