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
//! Read-only staged changes and literal working-tree observations.
//!
//! Call [`Repository::raw_status`](crate::Repository::raw_status) with [`Baseline`] to choose the
//! comparison tree and [`Untracked`] to choose whether raw untracked leaves are listed. [`Report`]
//! separates staged, unstaged, unmerged, unchecked gitlink, and boundary observations. Empty
//! change lists do not establish Git-default cleanliness or authorize checkout.
//!
//! [`Repository::raw_status`](crate::Repository::raw_status) deliberately compares raw bytes and
//! POSIX executable/symlink modes. It does not apply attributes, filters, EOL conversion, ignore
//! rules, `core.filemode`, `core.symlinks`, or ambient configuration. This is useful for consumers
//! that own normalization policy, and is **not Git-default status**.
//! Cached index stat words and assume-valid never bypass content verification. No index refresh,
//! locks, hooks, writes, rename detection, staging or checkout occur.
//!
//! Traversal is supported on Linux and macOS. Linux preserves non-UTF-8 filename bytes; macOS
//! accepts ASCII paths only because Unicode normalization aliases are not implemented. Exact
//! directory-name matching prevents case-folded aliases from being mistaken for tracked names.
//! Unsafe components and metadata aliases are rejected before conversion to platform paths.
//! NUL, backslashes, colons, empty/dot/parent components and case-insensitive `.git` components
//! are rejected on both platforms. Gitlinks and nested repositories are never recursively
//! inspected.
//!
//! # Example
//!
//! Stage a file in the index, change it in the working tree, and observe a raw unstaged change. The
//! report is an observation; nothing is refreshed or written:
//!
//! ```
//! use std::sync::atomic::AtomicBool;
//!
//! use girt::index::{Entry, Mode};
//! use girt::status::{Baseline, Change, Limits, Untracked};
//! use girt::{InitKind, ObjectFormat, Repository};
//!
//! # if cfg!(not(any(target_os = "linux", target_os = "macos"))) {
//! # return Ok(());
//! # }
//! let directory = tempfile::tempdir()?;
//! let repository = Repository::init(
//! ObjectFormat::Sha1,
//! directory.path().join("w"),
//! InitKind::Worktree,
//! )?;
//! let id = repository.loose_objects().write_blob(b"staged\n")?;
//! let mut edit = repository.edit_index(Default::default())?;
//! edit.replace_entries(vec![Entry::new(b"hello.txt".to_vec(), Mode::Regular, id)])?;
//! edit.commit()?;
//! let worktree = repository.worktree().expect("ordinary repository");
//! std::fs::write(worktree.join("hello.txt"), b"working\n")?;
//! std::fs::write(worktree.join("scratch.txt"), b"new\n")?;
//!
//! let report = repository.raw_status(
//! Baseline::Head,
//! Untracked::RawFilesWithoutIgnores,
//! Limits::default(),
//! &AtomicBool::new(false),
//! )?;
//! // HEAD is unborn, so the whole index is staged relative to an empty tree.
//! assert_eq!(report.staged[0].path, b"hello.txt");
//! assert_eq!(report.unstaged[0].path, b"hello.txt");
//! assert!(matches!(report.unstaged[0].change, Change::Modified(_)));
//! assert_eq!(report.raw_untracked, [b"scratch.txt".to_vec()]);
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
pub
pub use *;