iqdb-cache 1.0.0

In-process vector and result caching with LRU/LFU/ARC eviction - part of the iQDB family.
Documentation 
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

# ██████╗ ███████╗██████╗ ███████╗
# ██╔══██╗██╔════╝██╔══██╗██╔════╝
# ██████╔╝█████╗  ██████╔╝███████╗
# ██╔══██╗██╔══╝  ██╔═══╝ ╚════██║
# ██║  ██║███████╗██║     ███████║
# ╚═╝  ╚═╝╚══════╝╚═╝     ╚══════╝
#╔═══════════════════════════════╗
#║ Rust Efficiency & Performance ║
#╚═══════════════════════════════╝
[package]
name    = "iqdb-cache"
version = "1.0.0"

# Minimum Supported Rust Version (MSRV)
rust-version = "1.87"
edition = "2024"

# License
license = "Apache-2.0 OR MIT"

# Readme
readme = "README.md"

# Description
description = "In-process vector and result caching with LRU/LFU/ARC eviction - part of the iQDB family."

# Keywords (5 max)
keywords = [
    "cache",
    "vector-database",
    "eviction",
    "lru",
    "iqdb"
]

# Categories
categories = [
    "caching",
    "data-structures"
]

# Links
homepage      = "https://github.com/jamesgober/iqdb-cache"
repository    = "https://github.com/jamesgober/iqdb-cache"
documentation = "https://docs.rs/iqdb-cache"

# Authors
authors = [
    "James Gober <me@jamesgober.com>",
    "Matt Callahan <matthewcallahan01@icloud.com>"
]

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]

# `loom` and `docsrs` are first-party build cfgs this crate sets deliberately
# (loom concurrency model-checking; docs.rs feature gating). Declare them so the
# `unexpected_cfgs` lint stays quiet under `#![deny(warnings)]`.
[lints.rust]
unexpected_cfgs = { level = "warn", check-cfg = ['cfg(loom)', 'cfg(docsrs)'] }

[lib]
name = "iqdb_cache"
path = "src/lib.rs"


# FEATURE FLAGS
# #################################
[features]
# Default build: the cache wrapper over the std index traits, no optional
# dependencies. The crate is std-only — it builds on `iqdb-index`, which is.
default = []
# Derive `serde::{Serialize, Deserialize}` for `CacheStats`.
serde = ["dep:serde"]


# DEPENDENCIES
# #################################
[dependencies]
# The shared iQDB vocabulary: VectorId, Hit, SearchParams, DistanceMetric, Filter.
iqdb-types = "1.0.0"
# The trait this crate wraps: any `IndexCore` becomes a `CachedIndex`.
iqdb-index = "1.0.0"
# Monotonic, mockable time for result-cache TTL (the iQDB time standard).
clock-lib = "1.0.0"
# Optional: `CacheStats` serialization.
serde = { version = "1", optional = true, default-features = false, features = ["derive"] }


# DEV DEPENDENCIES
# #################################
[dev-dependencies]
criterion = { version = "0.5", features = ["html_reports"] }
proptest = "1"

# Loom is a real dependency under `--cfg loom` (the library swaps its `Mutex` and
# atomics for loom's instrumented types via `src/sync.rs`), not just a dev-dep.
# It is pulled only when concurrency model-checking; normal builds never see it.
[target.'cfg(loom)'.dependencies]
loom = "0.7"


# BENCHMARKS
# #################################
[[bench]]
name    = "cache_bench"
harness = false


# RELEASE PROFILE
# #################################
[profile.release]
opt-level     = 3
lto           = "fat"
codegen-units = 1
panic         = "abort"
strip         = "symbols"