moeix 0.11.8

Sub-millisecond code search via sparse trigram indexing.
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

//! ix — sub-millisecond code search via sparse trigram indexing.
//!
//! `ix` pre-computes a byte-level trigram index to narrow search candidates
//! to a fraction of the total file set, then verifies matches with a
//! memory-constant streaming architecture. This eliminates the linear-scan
//! bottleneck of traditional tools on large codebases.
//!
//! # Installation
//!
//! ```bash
//! cargo install moeix
//! ```
//!
//! # Quick Start
//!
//! ```bash
//! ix --build /path/to/repo
//! ix "fn validate"
//! ix --regex "fn\\s+\\w+_handler" --context 3
//! ```
//!
//! # Library Usage
//!
//! ```rust,ignore
//! use ix::reader::Reader;
//! use ix::executor::{Executor, QueryOptions};
//! use ix::planner::Planner;
//!
//! let reader = Reader::open(".ix/shard.ix")?;
//! let plan = Planner::plan("struct Config", false);
//! let mut executor = Executor::new(&reader);
//! let (matches, stats) = executor.execute(&plan, &QueryOptions::default())?;
//! ```
//!
//! # Module Build Order
//!
//! `format` → `varint` → `trigram` → `bloom` → `posting` →
//! `string_pool` → `builder` → `reader` → `planner` → `executor`
//!
//! Cache layer: `posting_cache` · `neg_cache` · `regex_pool` (used by `executor`)
//!
//! Policy: `cache_policy` (standalone, adapts to `ResourceGuard` pressure)
//!
//! Support: `scanner` (fallback, no index) · `streaming` (line/mmap alternatives) ·
//! `api` (convenience wrapper) · `config` (`.ixd.toml`)
//!
//! # See Also
//!
//! - [GitHub README](https://github.com/moeshawky/ix) — install, quick start, daemon
//! - [Socket API](https://github.com/moeshawky/ix/blob/main/docs/SOCKET-API.md) — daemon IPC protocol
//!
//! # Feature Flags
//!
//! - **`notify`** (default) — File watcher + daemon (`ixd`) + Unix domain socket IPC
//! - **`decompress`** — gz/zst/bz2/xz decompression
//! - **`archive`** — zip/tar archive support
//! - **`full`** — All optional features

// Lint configuration — Tier 1 security hardened, pedantic with pragmatic allow
#![warn(clippy::pedantic)]
#![allow(clippy::cast_possible_truncation)] // 64-bit target; try_from guards runtime
#![allow(clippy::cast_possible_wrap)] // controlled internal values
#![allow(clippy::cast_sign_loss)] // controlled internal values
#![allow(clippy::module_name_repetitions)] // module::Type is idiomatic
#![allow(clippy::too_many_lines)] // scanner/executor are well-structured
#![warn(missing_docs)] // enterprise: every public item documented
#![cfg_attr(test, allow(missing_docs))] // tests: no doc needed for test fns
#![warn(clippy::semicolon_if_nothing_returned)]
#![warn(clippy::non_ascii_literal)]
#![warn(clippy::unimplemented)]
#![warn(clippy::use_self)]
#![warn(clippy::string_slice)]
#![warn(clippy::clone_on_ref_ptr)]

extern crate llmosafe;

/// HTTP API surface for programmatic index access.
pub mod api;
/// ZIP and tar archive indexing support.
pub mod archive;
/// Bloom filter implementation for fast membership testing.
pub mod bloom;
/// Index builder — coordinates the pipeline from file discovery to shard serialization.
pub mod builder;
/// Adaptive cache policy driven by `ResourceGuard` memory pressure.
#[cfg_attr(docsrs, doc(cfg(feature = "notify")))]
pub mod cache_policy;
/// Runtime and build configuration, including `.ixd.toml` parsing.
pub mod config;
/// Background daemon that watches for file changes and rebuilds the index.
#[cfg(all(feature = "notify", unix))]
#[cfg_attr(docsrs, doc(cfg(feature = "notify")))]
pub mod daemon;
/// Unix domain socket IPC between the daemon and CLI clients.
#[cfg(all(feature = "notify", unix))]
#[cfg_attr(docsrs, doc(cfg(feature = "notify")))]
pub mod daemon_sock;
/// Decompression support for gz, zst, bz2, and xz files.
pub mod decompress;
/// Error types for the ix crate.
pub mod error;
/// Query executor — runs a search plan against the index.
pub mod executor;
/// Index file format definitions and magic bytes.
pub mod format;
/// Idle timeout tracker for the daemon process.
#[cfg(feature = "notify")]
#[cfg_attr(docsrs, doc(cfg(feature = "notify")))]
pub mod idle;
/// Negative result cache — skips re-verification of known non-matching files.
pub mod neg_cache;
/// Query planner — converts a pattern string into an execution plan.
pub mod planner;
/// Posting list storage for trigram-to-file mappings.
pub mod posting;
/// LRU cache for decoded posting lists, keyed by trigram.
pub mod posting_cache;
/// Index reader — loads and queries a pre-built shard.
pub mod reader;
/// Compiled regex pool — caches `Regex` objects to avoid recompilation.
pub mod regex_pool;
/// File scanner — fallback linear search when no index is available.
pub mod scanner;
/// Alternative streaming file search implementations — line-based and
/// mmap-windowed verification with context support.
pub mod streaming;
/// Deduplicated string storage for file paths and identifiers.
pub mod string_pool;
/// Trigram extraction and byte-level pattern matching.
pub mod trigram;
/// Variable-length integer encoding for compact index storage.
pub mod varint;
/// Filesystem watcher — monitors directories for file changes.
#[cfg(feature = "notify")]
#[cfg_attr(docsrs, doc(cfg(feature = "notify")))]
pub mod watcher;

#[cfg(feature = "notify")]
#[cfg_attr(docsrs, doc(cfg(feature = "notify")))]
pub use crate::builder::Builder;
#[cfg(all(feature = "notify", unix))]
#[cfg_attr(docsrs, doc(cfg(feature = "notify")))]
pub use crate::daemon_sock::{
    ClientMessage, DaemonClient, DaemonServer, FileChange, FileOp, ServerMessage,
};
#[cfg(feature = "notify")]
#[cfg_attr(docsrs, doc(cfg(feature = "notify")))]
pub use crate::format::Beacon;
#[cfg(feature = "notify")]
#[cfg_attr(docsrs, doc(cfg(feature = "notify")))]
pub use crate::idle::IdleTracker;
#[cfg(feature = "notify")]
#[cfg_attr(docsrs, doc(cfg(feature = "notify")))]
pub use crate::watcher::Watcher;

/// Run the daemon watching the given directory for changes and rebuilding the index.
///
/// This function is deprecated. Use [`crate::daemon::run`] instead.
///
/// # Errors
///
/// Delegates to [`daemon::run`]; see that function for error conditions.
#[cfg(all(feature = "notify", unix))]
#[deprecated(since = "0.7.0", note = "use ix::daemon::run instead")]
pub fn run_daemon(path: &std::path::Path) -> crate::error::Result<()> {
    crate::daemon::run(path)
}