Struct FileItem 

pub struct FileItem {
    pub path: PathBuf,
    pub relative_path: String,
    pub relative_path_lower: String,
    pub file_name: String,
    pub file_name_lower: String,
    pub size: u64,
    pub modified: u64,
    pub access_frecency_score: i64,
    pub modification_frecency_score: i64,
    pub total_frecency_score: i64,
    pub git_status: Option<Status>,
    pub is_binary: bool,
    /* private fields */
}

A single indexed file with metadata, frecency scores, and lazy content cache.

File contents are initialized lazily on the first grep access and cached for subsequent searches. On Unix, uses mmap backed by the kernel page cache. On Windows, reads into a heap buffer to avoid holding file handles open.

Thread-safety: OnceLock provides lock-free reads after initialization. Each file is only searched by one rayon worker at a time via par_iter.

Fields

path: PathBuf

relative_path: String

relative_path_lower: String

file_name: String

file_name_lower: String

size: u64

modified: u64

access_frecency_score: i64

modification_frecency_score: i64

total_frecency_score: i64

git_status: Option<Status>

is_binary: bool

Implementations

impl FileItem

pub fn new(path: PathBuf, base_path: &Path, git_status: Option<Status>) -> Self

pub fn update_frecency_scores( &mut self, tracker: &FrecencyTracker, mode: FFFMode, ) -> Result<(), Error>

impl FileItem

pub fn new_raw( path: PathBuf, relative_path: String, file_name: String, size: u64, modified: u64, git_status: Option<Status>, is_binary: bool, ) -> Self

Create a new FileItem with all fields specified and an empty (not yet loaded) mmap.

pub fn invalidate_mmap(&mut self)

Invalidate the cached content so the next get_content() call creates a fresh one.

Call this when the background watcher detects that the file has been modified. On Unix, a file that is truncated while mapped can cause SIGBUS. On Windows, the stale buffer simply won’t reflect the new contents. In both cases, invalidating ensures a fresh read on the next access.

pub fn get_content(&self) -> Option<&[u8]>

Get the cached file contents or lazily load them. Returns None if the file is too large, empty, or can’t be opened.

After the first call, this is lock-free (just an atomic load + pointer deref). On Unix, uses mmap backed by the kernel page cache. On Windows, reads into a heap buffer so the file handle is released immediately.

pub fn get_mmap(&self) -> Option<&[u8]>

Backward-compatible alias for get_content.

Trait Implementations

impl Clone for FileItem

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Constrainable for FileItem

fn relative_path(&self) -> &str

The file’s relative path (e.g. “src/main.rs”)

fn relative_path_lower(&self) -> &str

The file’s lowercased relative path for case-insensitive matching

fn file_name(&self) -> &str

The file name component (e.g. “main.rs”)

fn git_status(&self) -> Option<Status>

The git status of this item, if available

impl Debug for FileItem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.