[package] name = "quicksearch-core" version.workspace = true edition.workspace = true license.workspace = true authors.workspace = true repository.workspace = true description = "Indexing, storage and search engine behind QuickSearch." [lib] name = "quicksearch_core" path = "src/lib.rs" # Several dependencies below are named directly despite already being in the # lockfile transitively ("transitive already"): they compile nothing new. [dependencies] # `bundled-sqlcipher-vendored-openssl` compiles the SQLCipher amalgamation # (a superset of the stock SQLite `bundled` build — FTS5 etc. included) and # statically links a vendored OpenSSL libcrypto, so encryption support adds # no runtime library dependencies. With no `PRAGMA key` applied, SQLCipher # behaves identically to stock SQLite, so unencrypted indexes are unaffected. rusqlite = { version = "0.39", features = ["bundled-sqlcipher-vendored-openssl"] } argon2 = { version = "0.5", features = ["zeroize"] } zeroize = { version = "1", features = ["derive"] } getrandom = "0.2" sha2 = "0.10.8" walkdir = "2.5.0" # Default features pull in zstd 0.11, which cannot unify with our zstd 0.13 below # and so builds a second copy of the wrapper crates. We only read OOXML/ODF # containers (docx/xlsx/pptx/odt/ods/odp), whose entries are always deflate or # stored, so zstd/bzip2/aes-crypto are all dead weight here. zip = { version = "0.6", default-features = false, features = ["deflate"] } quick-xml = "0.41" # OLE2 compound-file reader, for the pre-2007 binary Office formats # (.doc/.xls/.ppt) whose text lives in named streams, not a zip. Transitive # already (infer). cfb = "0.7" serde = { version = "1.0", features = ["derive"] } # 1.x, not 0.8: 0.8 pulls `toml_edit` + a second `winnow` (~252 KB of `.text`) # for a format-preserving document API this crate never touches. toml = "1" mime_guess = "2.0" infer = "0.15" # Charset decoding for non-UTF-8 text (UTF-16 .reg exports, legacy # single-byte and CJK encodings). Transitive already (pdf-extract). encoding_rs = "0.8" # Statistical charset detection (Firefox's detector) for text that is neither # UTF-8 nor BOM-marked. Its mandatory deps beyond encoding_rs are tiny # (cfg-if, memchr, detone). chardetng = "1.0" # RTF text extraction. Resolves to `vendor/rtf-parser` via the workspace # `[patch.crates-io]` (see there for why). 0.4 is what the patch is against; # `default-features = false` is redundant against the vendored copy but keeps # a registry fallback from pulling wasm-bindgen. rtf-parser = { version = "0.4", default-features = false } # `lopdf` is deliberately NOT declared here. `pdf-extract` re-exports it # (`pub use lopdf::*`), and `extract/pdf.rs` reaches it that way. Naming it # directly resolves a *second*, older copy alongside pdf-extract's — which is # what used to make every PDF parse twice, and what pulled in rayon (whose # global thread pool is never torn down), chrono, time, md5 and a second nom. pdf-extract = "0.12" lofty = "0.19" notify = "6.1" ctrlc = "3.4" zstd = "0.13" globset = "0.4" regex = "1" # Required-literal extraction for the `regex:` prefilter: the same analysis the # regex engine does to pick its own prefilter, reused to narrow which rows the # regex passes ever see. Transitive already (regex). regex-syntax = "0.8" # SIMD substring search for the full-text passes: std's Two-Way searcher has # no vector prefilter and measured ~45x slower (`benches/search.rs`, # `substring`). Transitive already (regex, globset, chardetng). memchr = "2" # `nice()`, for dropping indexing threads to background scheduling priority. # Linux schedules per task, so it affects only the calling thread. Transitive # already (rusqlite, getrandom). [target.'cfg(unix)'.dependencies] libc = "0.2" # `GetDriveTypeW`, thread priorities, and the FILE_ATTRIBUTE_* constants # `platform.rs` spells out for itself (so its tests run on Linux) and # const-asserts against on Windows builds. Pinned to 0.52: walkdir → # winapi-util already resolves exactly that version. [target.'cfg(windows)'.dependencies] # DRIVE_REMOTE is, oddly, in Win32_System_WindowsProgramming; # Win32_System_Threading carries SetThreadPriority and needs Win32_Foundation # for HANDLE/BOOL. windows-sys = { version = "0.52", features = [ "Win32_Foundation", # SECURITY_ATTRIBUTES, which `CreateFileW`'s signature names even though # the directory-count path passes null for it. "Win32_Security", "Win32_Storage_FileSystem", # OVERLAPPED, which `LockFileEx` takes for the index's instance lock. # `LockFileEx` and `GetDiskFreeSpaceExW` themselves are in # Win32_Storage_FileSystem above. "Win32_System_IO", "Win32_System_Threading", "Win32_System_WindowsProgramming", ] } # Microbenchmark harness for `benches/`. Criterion was rejected: it pulls # rayon (a never-torn-down global thread pool) plus plotters and clap, some # forty crates. Divan's set is a handful and it spawns no threads of its own. [dev-dependencies] divan = "0.1" # Writers for `tests/extraction_corpus.rs`, each deliberately a *different # implementation* from the reader it feeds — a fixture built with the reader's # own library proves only self-agreement. (`src/extract/` unit tests use the # readers' libraries on purpose: they target malformed input.) `.doc`/`.xls`/ # `.ppt` are committed LibreOffice fixtures instead — nothing in Rust writes # OLE2 but `cfb`, the reader. See `tests/fixtures/legacy/`. # # docx: writes its own OOXML over `zip` 8.x (our reader uses 0.6). The default # `image` feature would pull the whole `image` crate for nothing. docx-rs = { version = "0.4", default-features = false } # xlsx: builds a real shared-string table, which is the path `extract_xlsx` # actually cares about. rust_xlsxwriter = { version = "0.98", default-features = false } # pdf: typst's low-level writer. No `lopdf` anywhere in its tree, which is what # makes it independent of `pdf-extract`. pdf-writer = "0.15" # audio tags: `id3` writes the ID3v2 frames `lofty` reads back, `metaflac` # the Vorbis comment block. The FLAC stream is a committed fixture — `lofty` # derives stream properties from a real CRC-checked frame; see # `tests/corpus/audio.rs`. id3 = "1" metaflac = "0.2" # CRC32 for the hand-rolled stored-entry zip that builds the pptx and ODF # containers. Transitive already (zip). crc32fast = "1" # Declared only to turn its test harness on: examples are otherwise # auto-discovered, and this one carries unit tests for the collision # arithmetic it reports. `cargo test -p quicksearch-core --example hashprobe` # runs them. [[example]] name = "hashprobe" path = "examples/hashprobe.rs" test = true # `harness = false` on both: divan supplies its own `main` via `divan::main()`, # so libtest must not also link one in. [[bench]] name = "search" harness = false [[bench]] name = "index" harness = false # Plain-main measurement probes, env-gated (QSB_SEARCH_PERF / QSB_SEARCH_ALLOC) # so a bare `cargo bench` doesn't pay their seed cost. snippet_perf, which # compared the pre-schema-v3 FTS shape against v3, is gone: the question is # decided (v3 won on every axis) — don't re-measure it. [[bench]] name = "search_perf" harness = false [[bench]] name = "search_alloc" harness = false