ingraph 0.1.0

A declaration-driven indexing framework: records and nodes are written as Rust types, and the storage rows, the dataflow between them and the GraphQL query surface are emitted from the declaration.
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
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
//! The blob family's three seams, each in BOTH modes: [`AsyncBlobEngine`] / [`BlobEngine`] (the per-slot
//! handle), [`AsyncLocate`] / [`Locate`] (its optional address capability) and [`AsyncBlobStore`] /
//! [`BlobStore`] (the construction layer that mints the handle).
//!
//! # Why this family is twinned, when most are not
//!
//! The dual-mode law's criterion is not *is the trait async* — it is *can the underlying act happen
//! NATIVELY BLOCKING*. Most seams fail it and are refused a twin on purpose: serving GraphQL,
//! waiting on a doorbell, sqlx's own socket. Twinning one of those manufactures the reverse fiction.
//!
//! Blob I/O passes it outright, and it is the record world's one member that does. A file read IS a
//! blocking syscall; `std::fs` is the direct spelling and `tokio::fs` is `spawn_blocking` wearing a
//! coat. So the blocking face here is not a convenience over the async one — it is the act, and the
//! async face is what BRIDGES to it. The shipped filesystem citizens below are written that way and
//! say so: [`BlobEngine`] holds the body, [`AsyncBlobEngine`] delegates to it and resolves immediately.
//!
//! # The two faces are SIBLINGS, and a backend implements what it can honestly answer
//!
//! Neither trait is a supertrait of the other, and the choice is load-bearing in both directions. A
//! supertrait `BlobEngine<R>: AsyncBlobEngine<R>` would tax a blocking-only store with an async face
//! nobody asked it for; the reverse would make every remote store implement a blocking one it cannot
//! honestly write. What a store CAN answer is what it implements, and a caller's bound is what says
//! which face it needs — a sync body over an async-only backend is `E0277` at the bound, naming the
//! two roads, rather than a runtime block-on nobody chose.
//!
//! The cost of siblings is that a store answering BOTH has two `put`s, two `get`s, two `read`s and
//! two `locate`s reachable by one name. It was MEASURED here rather than assumed: every call site in
//! this tree already spells the trait — `AsyncBlobEngine::<Frame>::put(&handle, …)`,
//! `AsyncLocate::<Frame>::locate(…)` — because `R` is otherwise uninferable from the arguments. The
//! disambiguation the collision would cost is therefore already written, and the shipped filesystem
//! handle implements all four faces with no suffix anywhere.
//!
//! # Which verbs the criterion actually twins, one seat finer
//!
//! The mode split is per ACT and not per trait, so the family is not uniformly twinned inside:
//!
//! | verb | mode | why |
//! |---|---|---|
//! | `put` / `get` / [`read`](AsyncBlobEngine::read) | async here, sync on the twin | file I/O, natively blocking |
//! | [`locate`](AsyncLocate::locate) / [`location`](AsyncLocate::location) | SYNC on both faces | a LOCAL render — no round trip, so no mode to differ in |
//!
//! [`AsyncLocate`] and [`Locate`] are therefore method-identical, and they still both exist: the
//! sibling law is about which face a store REACHES ITS SEATS THROUGH, not about which verbs differ.

use core::future::{Future, ready};
use std::convert::Infallible;

use smol_bytes::Utf8Bytes;

use super::Connected;
use crate::Transformer;

/// A blob store (local filesystem, S3, …), **generic over the record `R`** it stores: UNBOUNDED
/// over `R`, with only [`get`](Self::get) — whose signature projects `R::Key` — carrying the
/// method-level `where R: Transformer`. [`put`](Self::put) takes a bare `&R`.
///
/// `put` writes `R::bytes()` at the address derived from `R::key()` — a keyed replace,
/// last-write-wins — and returns nothing: a blob is a DERIVED artifact, so its corruption detector
/// is the consumer and its recovery is regenerate, not a stored-hash verify. `get` reads by
/// `R::Key`, resolving the same address, into the backend's [`Payload`](Self::Payload).
///
/// The write side carries the bytes IN MEMORY, through the record (`R::bytes()`); a streaming /
/// multipart upload is future ADDITIVE surface — a distinct method — and is neither implied by this
/// trait nor foreclosed by it.
pub trait AsyncBlobEngine<R> {
  /// **PER-SLOT CREATION INPUT** — the knobs an author states for ONE home this engine makes.
  ///
  /// # It has a spender now, and the spender is LAYER TWO
  ///
  /// The seat was reserved and honest about being reserved: *a reserved extension point, `()` where
  /// a backend needs none*. What it was waiting for is the initialization walk. A slot maker CREATES
  /// the home a blueprint describes, and the half of that description a DECLARATION cannot state is
  /// the deployment's — a tokenizer, an analyzer chain, an `ef`, a replication factor. Those arrive
  /// at BOOT and belong to nobody but the engine, so the walk's own per-slot table is typed on this
  /// member and the value crosses at the store's own `create_slot` door, one per corpus — see the
  /// shipped tantivy backend, where the first one is written.
  ///
  /// # Why it is not on the blueprint
  ///
  /// A [`Describe`](crate::Describe) blueprint is a `const`, so a descriptor built per boot is a
  /// schema that could differ between two of them. A knob a document decides is exactly such a
  /// value, which is why it lives on the VISITOR — see [`Habitat`](crate::Habitat), where the split
  /// is written down.
  ///
  /// # `()` where a backend needs none
  ///
  /// Still the shipped answer, and the reservation still buys what it bought: adding the member
  /// LATER would break every engine impl there is, and adding a value to it now is purely additive.
  type Options;
  /// This backend's failure.
  type Error;
  /// The read body `get` yields — BACKEND-CHOSEN, so a remote store can hand back a zero-copy body
  /// (refcounting the response buffer) instead of re-buffering into a `Vec<u8>`, while a filesystem
  /// backend that already owns an owned buffer off its read picks `Vec<u8>`. Nothing is erased, and
  /// hardening this to `Vec<u8>` is refused in advance: the second implementation that would break
  /// under it is already in view.
  type Payload;
  /// The shared connection-manager (the [`AsyncBlobStore`] that opened it), reached via
  /// `ctx.connection()` — the one store handle / client, held ONCE, not reopened per call. PLAIN,
  /// not a GAT.
  type Connection;
  /// The read-path (`get`) scope (may borrow) — a read lease. Reads resolve against committed
  /// state; it must not enable writes.
  type ReadContext<'a>;
  /// The write-path (`put`) scope (may borrow) — the per-write scope whose commit belongs to the
  /// caller.
  type WriteContext<'a>;

  /// Store one record — a keyed replace on `R::key()` writing `R::bytes()`. Takes a bare `&R` with
  /// no bound; a backend impl names the record capability its own body needs.
  fn put(
    &self,
    ctx: Connected<'_, Self::Connection, Self::WriteContext<'_>>,
    record: &R,
  ) -> impl Future<Output = Result<(), Self::Error>> + Send;

  /// Read the bytes stored at `key`, as the backend's [`Payload`](Self::Payload). Its signature
  /// projects ONLY `R::Key` — never `R::Bytes` — so it carries the identity capability alone, as a
  /// method-level `where R: Transformer`.
  ///
  /// The address a backend derives comes from `R` as much as from `key`: from the key's own
  /// rendering AND, where a backend appends one, `R::extension()`. Nothing ties the `R` a `put`
  /// used to the `R` a `get` uses — reading through a second record type that renders its key or
  /// its extension differently resolves a DIFFERENT address, and the read simply misses. Write and
  /// read through the same record type; the pairing is convention, not a type-level tie.
  fn get(
    &self,
    ctx: Connected<'_, Self::Connection, Self::ReadContext<'_>>,
    key: &R::Key,
  ) -> impl Future<Output = Result<Self::Payload, Self::Error>> + Send
  where
    R: Transformer;

  /// Read the bytes stored at `key` under an EXPLICIT `suffix` — [`get`](Self::get)'s sibling for a
  /// caller that decided the address's tail itself.
  ///
  /// # Why a second verb rather than a parameter on the first
  ///
  /// [`get`](Self::get) resolves the tail through [`BlobRecord::extension`], which is TYPE-LEVEL and
  /// has to be: a by-key read has no record instance to ask, so what a `put` appended must be
  /// reconstructible from the type. That seat is untouched and its reason still holds THERE.
  ///
  /// What it cannot answer is a family whose suffix is decided PER ENTRY — off a column of the row
  /// the caller is holding. The value exists, but only where the row does, and the only way across
  /// this seam is a parameter. So the suffix arrives as one, and the two verbs are the two
  /// authorities: the TYPE for a read that has nothing but a key, the CALLER for a read that has the
  /// row.
  ///
  /// [`None`] on `suffix` means EXTENSIONLESS — the address ends at the key's last segment. It does
  /// not mean *ask the type*, and the difference is deliberate: a caller that wants the type's
  /// answer calls [`get`](Self::get), which is the verb whose whole subject that is.
  ///
  /// This is I/O, so it is a future here and a plain `Result` on
  /// [`BlobEngine::read`](BlobEngine::read) — the dual-mode law's criterion answering, the
  /// same way `get` already answers it.
  ///
  /// # ABSENCE IS A VALUE, and it costs the read nothing
  ///
  /// [`None`] in the ANSWER is *there is nothing stored at that address*, which is the ordinary
  /// state of an artifact whose pipeline has not reached this entity yet — the same state
  /// [`ArtifactStore::locate`](crate::ArtifactStore::locate) answers a `None` for, now spelled at
  /// the second store-mediated road so the two say ONE thing. A backend already learns it on the way
  /// past: the read goes and looks, and what it finds is either bytes or the knowledge that there
  /// are none, so surfacing that knowledge is a widening of the RETURN rather than a second act.
  ///
  /// [`Error`](Self::Error) keeps what actually went wrong — a permission, a path component that is
  /// not a directory, a store that could not be reached. `Ok(None)` and `Err` are two sentences: *I
  /// looked and there is nothing* against *I could not look*, and a backend folding the second into
  /// the first would publish an absence for a broken deployment.
  fn read(
    &self,
    ctx: Connected<'_, Self::Connection, Self::ReadContext<'_>>,
    key: &R::Key,
    suffix: Option<&str>,
  ) -> impl Future<Output = Result<Option<Self::Payload>, Self::Error>> + Send
  where
    R: Transformer;
}

/// Resolve a blob's ADDRESS without reading it — the wire-facing ref.
///
/// An OPTIONAL capability and a SUPERTRAIT of the [`AsyncBlobEngine`] face it extends. Standalone it could
/// not spell its own `Connected<…>` parameter — it has no `Connection` / `ReadContext` to project —
/// and a handle typically holds only its slot, the root living on the
/// [`Connection`](AsyncBlobEngine::Connection), so a handle-only `locate` could not even render an address.
///
/// [`locate`](Self::locate) is a PURE address render — NO existence check, and NO ROUND TRIP: the
/// store renders the address out of what it already holds, which is what lets a caller hand out a
/// reference having touched nothing, and what keeps this from being a `get` that throws its bytes
/// away.
///
/// # SYNCHRONOUS on both faces, and the pin is what says so
///
/// Neither verb here returns a future, on this face or on [`Locate`], and the pin above is
/// the reason rather than a mode judgement: a render out of what the store already holds cannot be
/// waiting for anything. A filesystem joins its root to the key's segments; an object store
/// concatenates a prefix, or signs a URL out of credentials it is already carrying. Both are LOCAL
/// rendering, so an `async fn` here would be an `async fn` in name only — which is precisely the
/// fiction the dual-mode law refuses in the other direction.
///
/// That leaves this capability with NO mode difference at all, and the twin below exists anyway for
/// the sibling law's own reason: a blocking-only store must reach its `Connection` and its scopes
/// through a face it implements, and [`AsyncBlobEngine`] is not that face.
///
/// # THE LOCATION IS THE BACKEND'S, and the seat that says so is BARE
///
/// [`Location`](Self::Location) carries NO bound naming a wire library, a serializer or a shape.
/// The backend defines it — `FsLocation { path, size }`, `S3Location { url, etag, size }`, whatever
/// a store actually knows about where its bytes are — exactly as `type Score` is the ENGINE's on the
/// two search seams. A bound here would make every location the property of whichever library the
/// bound named, and a second backend could not answer without that library compiled.
///
/// Where the form is SPENT is where it is demanded: a wire face returning a location asks it for
/// [`ToGraphqlOutput`](crate::ToGraphqlOutput) structurally, and a location no binding can render
/// fails at that face rather than at this seat. It is [`ToGraphqlOutput::Output`]'s own law, one
/// layer down, and it is what keeps the ORPHAN RULE out of a backend's way: the location is the
/// backend's LOCAL type, so its crossing row is an ordinary local impl.
///
/// [`BlobLocation`](super::BlobLocation) is A citizen of that seat and never THE law — the
/// convenience shape a backend with nothing more to say elects, and the one this crate's own
/// filesystem store takes.
///
/// # TWO members, because a bare seat has no producer the framework could write
///
/// Nothing generic can build a `Self::Location` — no bound means no constructor, no `From`, no
/// conversion this crate could call. So the backend that DEFINES the type is the one that MINTS it,
/// and [`location`](Self::location) is where. The alternative — a bound supplying the conversion —
/// is the law this seat exists to refuse.
pub trait AsyncLocate<R>: AsyncBlobEngine<R> {
  /// The backend-chosen address handle — a path for a filesystem, a URL or object name for a remote
  /// store. Backend-CHOSEN for the reason [`AsyncBlobEngine::Payload`] is, and hardened to neither.
  ///
  /// # Why it takes a lifetime, when every shipped reference owns its bytes
  ///
  /// A seat is only as bare as its POSITION, and a non-GAT `type Ref` is not bare: it says *and it
  /// borrows nothing from the connection*, which is a constraint on every future backend that
  /// nobody ruled. A store whose address is a slice of a manifest it already holds — an object name
  /// interned in the client's own table, a prefix owned by the connection-manager — would have to
  /// COPY to answer, and the copy would exist because of this line rather than because of anything
  /// the backend needed.
  ///
  /// `'a` is [`locate`](Self::locate)'s own borrow: the handle and the
  /// [`Connection`](AsyncBlobEngine::Connection) behind `ctx` at once, which is the pair a reference could
  /// have come out of. `where Self: 'a` is the ordinary well-formedness the seat needs to be
  /// projected at that borrow, and a backend with nothing to borrow writes an owned type
  /// (`type Ref<'a> = PathBuf`) and never spends the parameter — the shipped filesystem store is
  /// exactly that.
  type Ref<'a>
  where
    Self: 'a;
  /// WHERE a blob is, as this backend describes it — the carrier a caller hands on, and the form a
  /// wire face returns.
  ///
  /// BARE: no bound, for the reason the trait note gives. The ADDRESS inside it renders as text —
  /// that is what a client can round-trip — and the structure AROUND the address is the backend's
  /// alone.
  type Location;
  /// The address-resolution failure — a SEPARATE associated type from [`AsyncBlobEngine::Error`], because a
  /// second `type Error` under the supertrait makes every generic `L::Error` use `E0221`-ambiguous.
  /// `Send + Sync + 'static` so a resolver can surface it as a wire error.
  ///
  /// [`location`](Self::location) reports through it too, and deliberately: rendering an address is
  /// the tail of resolving one, and a third `type Error` would make `L::LocateError` ambiguous the
  /// way a second one already would.
  type LocateError: core::error::Error + Send + Sync + 'static;

  /// Resolve the on-store ADDRESS of `key`'s blob WITHOUT reading it. Its signature projects only
  /// `R::Key`, so it carries the identity capability alone — the rest of the address is `suffix`,
  /// which the CALLER decided.
  ///
  /// `suffix` is the tail the address ends with, or [`None`] for an extensionless one. It is a
  /// PARAMETER and not a projection off `R` for [`AsyncBlobEngine::read`]'s reason, written out there in
  /// full: a family whose suffix is decided per entry has that value only where the row is, and a
  /// parameter is the only way across this seam. [`None`] means extensionless and never *ask the
  /// type*.
  ///
  /// ONE lifetime, over the handle, the connection borrow and the key together — the same choice
  /// [`Connected`] itself makes and for the same reason: a reference may come out of any of the
  /// three, so `'a` is their intersection, and every one of them is covariant, so a caller holding
  /// them at different lifetimes still passes them here unchanged. `suffix` is NOT under it: a
  /// backend renders the tail INTO the address it is building rather than borrowing it onward, so
  /// tying it to `'a` would demand a caller's own computed suffix outlive the borrow it was computed
  /// under — which is exactly the shape a per-entry suffix has.
  ///
  /// # Errors
  ///
  /// [`LocateError`](Self::LocateError) where the address cannot be rendered — a slot, a key or a
  /// suffix the backend will not name a stored object after.
  fn locate<'a>(
    &'a self,
    ctx: Connected<'a, Self::Connection, Self::ReadContext<'a>>,
    key: &'a R::Key,
    suffix: Option<&str>,
  ) -> Result<Self::Ref<'a>, Self::LocateError>
  where
    R: Transformer;

  /// Describe a resolved address — the backend's own [`Location`](Self::Location) around it.
  ///
  /// INFALLIBLE of I/O, which is [`locate`](Self::locate)'s pin carried to its end:
  /// the pair resolves and describes without one round trip between them, so a caller holding a key
  /// hands out a location having touched no store. A backend wanting a fact only the store knows —
  /// a size, an etag — reads it from what it already holds, or leaves it unsaid; it does not go and
  /// ask, because a `locate` that secretly stats is the `get`-that-throws-its-bytes-away this
  /// capability exists instead of.
  ///
  /// That law is THIS layer's, and the family seam above it keeps it rather than trading it away.
  /// [`ArtifactStore::locate`](crate::ArtifactStore::locate) answers a wire field whose two lawful
  /// answers are an address and *not yet generated*, so absence is a value it has to be ABLE to
  /// produce — and which stores can produce it is a fact about them: one holding presence as a row
  /// column answers `None` for free, where a filesystem would have to spend a `stat` whose answer
  /// expires as it is produced. The shipped family therefore spends this render to build its address
  /// and answers `Some`; nothing at either layer goes looking on a caller's behalf, and absence
  /// under it is discovered at USE — in [`ArtifactData::read`](crate::ArtifactData::read), which
  /// finds it for free, or at the client's own fetch.
  ///
  /// It CONSUMES the reference: a location is what the address becomes, so nothing is left beside it
  /// to go out of step.
  ///
  /// # Errors
  ///
  /// [`LocateError`](Self::LocateError) where the address has no rendering — the filesystem store's
  /// non-UTF-8 path is the shipped instance.
  ///
  /// It takes the reference at the SAME `'a` [`locate`](Self::locate) minted it under, and it must:
  /// `Self::Ref<'x>` is only well-formed where `Self: 'x`, and `&'a self` is what puts that bound in
  /// scope. A borrowing reference therefore describes itself while the store that lent it is still
  /// there, which is the honest reading of a pure render — nothing is fetched, so nothing outlives
  /// what it was read out of.
  fn location<'a>(&'a self, reference: Self::Ref<'a>) -> Result<Self::Location, Self::LocateError>;
}

/// Construction for a blob store — key-addressed under ONE connection-manager, partitioned by
/// artifact-family slot.
///
/// A `*Store` IS the [`Connection`](AsyncBlobEngine::Connection) its handles borrow: opened once by
/// [`open`](Self::open), its per-slot factory mints a STATELESS handle that reaches back through
/// `ctx.connection()`, so nothing reconnects per call. `open`'s future is `Send` (a multi-threaded
/// runtime); [`blob`](Self::blob) is SYNC and INFALLIBLE — a stateless handle needs no I/O to mint,
/// so any per-slot open happens lazily behind the shared manager on first use. `: Sized` because
/// `open` returns `Self` by value.
pub trait AsyncBlobStore: Sized {
  /// How to open the connection-manager — a root directory, client options. Open for the reason
  /// [`AsyncBlobEngine::Payload`] is: hardening it to a path is refused in advance.
  type Options;
  /// An open failure.
  type Error;
  /// The stateless per-slot handle produced — its `Connection` is `Self`.
  type Handle;

  /// Open the connection-manager (a pool / client) ONCE.
  fn open(options: Self::Options) -> impl Future<Output = Result<Self, Self::Error>> + Send;

  /// The stateless handle for blob slot `slot` — the artifact family (`thumbnail`, `waveform`, …),
  /// the FIRST segment of a blob's hierarchical object name. A filesystem renders it as the first
  /// path level under the root, an object store as the leading object-key segment.
  fn blob(&self, slot: impl Into<Utf8Bytes>) -> Self::Handle;
}

/// A blob store served on THIS THREAD — [`AsyncBlobEngine`]'s blocking twin, and on a filesystem the face
/// that holds the act rather than the one that wraps it.
///
/// Same shape, same law, one difference: every verb answers a [`Result`] where the async face
/// answers a future. Nothing is `Send`-bounded here, and the absence is a fact rather than an
/// omission — a bound that exists to let a future cross threads has nothing to say about a call that
/// returns before it could.
///
/// # Its associated types are its OWN, and that is what makes it a sibling
///
/// The six seats are declared again rather than projected off [`AsyncBlobEngine`]. That is the cost of the
/// sibling shape and it is paid deliberately: a store that implements ONLY this face still needs a
/// `Connection`, a `Payload` and its two scopes, and reaching them through a trait it does not
/// implement is not something a bound can spell. A store implementing both writes the seats twice
/// and is free to resolve them differently — a blocking read handing back a memory-mapped body while
/// its async face buffers is a real backend, and nothing here forbids it.
///
/// Generic code over a dual-face store names the face it means (`<H as BlobEngine<R>>::Error`),
/// which is the ordinary `E0221` discipline this family already carries one seat down.
#[diagnostic::on_unimplemented(
  message = "`{Self}` has no BLOCKING blob face",
  label = "this store answers through futures, and a sync body cannot spend one",
  note = "two roads: implement `BlobEngine` for a store whose I/O is natively blocking (a \
          filesystem, a memory-mapped volume), or move the caller onto the async face `AsyncBlobEngine` — \
          wrapping an async store in a block-on here would be the fiction the dual-mode law exists \
          to refuse"
)]
pub trait BlobEngine<R> {
  /// **PER-SLOT CREATION INPUT** — the knobs an author states for ONE home this engine makes.
  ///
  /// # It has a spender now, and the spender is LAYER TWO
  ///
  /// The seat was reserved and honest about being reserved: *a reserved extension point, `()` where
  /// a backend needs none*. What it was waiting for is the initialization walk. A slot maker CREATES
  /// the home a blueprint describes, and the half of that description a DECLARATION cannot state is
  /// the deployment's — a tokenizer, an analyzer chain, an `ef`, a replication factor. Those arrive
  /// at BOOT and belong to nobody but the engine, so the walk's own per-slot table is typed on this
  /// member and the value crosses at the store's own `create_slot` door, one per corpus — see the
  /// shipped tantivy backend, where the first one is written.
  ///
  /// # Why it is not on the blueprint
  ///
  /// A [`Describe`](crate::Describe) blueprint is a `const`, so a descriptor built per boot is a
  /// schema that could differ between two of them. A knob a document decides is exactly such a
  /// value, which is why it lives on the VISITOR — see [`Habitat`](crate::Habitat), where the split
  /// is written down.
  ///
  /// # `()` where a backend needs none
  ///
  /// Still the shipped answer, and the reservation still buys what it bought: adding the member
  /// LATER would break every engine impl there is, and adding a value to it now is purely additive.
  type Options;
  /// This backend's failure.
  type Error;
  /// The read body [`get`](Self::get) yields — BACKEND-CHOSEN, for [`AsyncBlobEngine::Payload`]'s reason and
  /// with one seat's more freedom: nothing surrounds this one, so a body that is neither `Send` nor
  /// `'static` binds here where the async face's future would have refused it.
  type Payload;
  /// The shared connection-manager, reached via `ctx.connection()`. PLAIN, not a GAT.
  type Connection;
  /// The read-path scope (may borrow) — a read lease. Reads resolve against committed state.
  type ReadContext<'a>;
  /// The write-path scope (may borrow) — the per-write scope whose commit belongs to the caller.
  type WriteContext<'a>;

  /// Store one record — a keyed replace on `R::key()` writing `R::bytes()`, completed before this
  /// returns.
  fn put(
    &self,
    ctx: Connected<'_, Self::Connection, Self::WriteContext<'_>>,
    record: &R,
  ) -> Result<(), Self::Error>;

  /// Read the bytes stored at `key`. Its signature projects ONLY `R::Key`, so it carries the
  /// identity capability alone — [`AsyncBlobEngine::get`]'s note on write/read pairing holds here verbatim.
  fn get(
    &self,
    ctx: Connected<'_, Self::Connection, Self::ReadContext<'_>>,
    key: &R::Key,
  ) -> Result<Self::Payload, Self::Error>
  where
    R: Transformer;

  /// Read the bytes stored at `key` under an EXPLICIT `suffix`, on this thread — [`AsyncBlobEngine::read`]'s
  /// blocking twin, whose whole note holds here verbatim.
  ///
  /// This is the verb the criterion twins, where [`Locate::locate`] beside it is not: a file
  /// read IS a blocking syscall, so the two faces differ, and rendering an address is neither, so
  /// they do not.
  ///
  /// The ANSWER is widened for [`AsyncBlobEngine::read`]'s reason, restated at the mode that holds the act:
  /// `Ok(None)` is *there is nothing stored there*, and [`Error`](Self::Error) is *I could not
  /// look*. A twin that kept the narrow shape would make the two faces of one act disagree about
  /// what absence is.
  fn read(
    &self,
    ctx: Connected<'_, Self::Connection, Self::ReadContext<'_>>,
    key: &R::Key,
    suffix: Option<&str>,
  ) -> Result<Option<Self::Payload>, Self::Error>
  where
    R: Transformer;
}

/// Resolve a blob's ADDRESS without reading it, on THIS THREAD — [`AsyncLocate`]'s blocking twin.
///
/// A SUPERTRAIT of [`BlobEngine`] and not of [`AsyncBlobEngine`], which is the sibling law read at the
/// capability layer: the face this one extends is the face it borrows its `Connection` and its
/// scopes from, so a blocking-only store reaches its own seats and never names the async trait.
///
/// BOTH verbs are IDENTICAL to the async face's — neither was ever waiting for anything, because
/// rendering an address does no I/O. They are restated rather than shared for the reason the six
/// seats above are: a store implementing only this face has no other trait to find them on.
///
/// A capability whose twin differs in nothing is the criterion answering honestly rather than a
/// duplication: what the dual-mode law twins is an ACT that can happen natively blocking, and there
/// is no act here to have two speeds. The pair that DOES differ is
/// [`read`](BlobEngine::read) / [`AsyncBlobEngine::read`], one seat down.
pub trait Locate<R>: BlobEngine<R> {
  /// The backend-chosen address handle, at [`locate`](Self::locate)'s own borrow — see
  /// [`AsyncLocate::Ref`] for why the seat takes a lifetime.
  type Ref<'a>
  where
    Self: 'a;
  /// WHERE a blob is, as this backend describes it. BARE, for [`AsyncLocate::Location`]'s reason.
  type Location;
  /// The address-resolution failure — SEPARATE from [`BlobEngine::Error`], because a second
  /// `type Error` under the supertrait makes every generic `L::Error` use `E0221`-ambiguous.
  type LocateError: core::error::Error + Send + Sync + 'static;

  /// Resolve the on-store ADDRESS of `key`'s blob WITHOUT reading it — a PURE render, no existence
  /// check, no round trip, and `suffix` deciding the address's tail. See [`AsyncLocate::locate`], whose
  /// note holds here word for word.
  ///
  /// # Errors
  ///
  /// [`LocateError`](Self::LocateError) where the address cannot be rendered.
  fn locate<'a>(
    &'a self,
    ctx: Connected<'a, Self::Connection, Self::ReadContext<'a>>,
    key: &'a R::Key,
    suffix: Option<&str>,
  ) -> Result<Self::Ref<'a>, Self::LocateError>
  where
    R: Transformer;

  /// Describe a resolved address — the backend's own [`Location`](Self::Location) around it.
  ///
  /// # Errors
  ///
  /// [`LocateError`](Self::LocateError) where the address has no rendering.
  fn location<'a>(&'a self, reference: Self::Ref<'a>) -> Result<Self::Location, Self::LocateError>;
}

/// Construction for a blob store whose OPENING is a blocking act — [`AsyncBlobStore`]'s twin, and the
/// narrowest of the three: it differs in exactly one verb.
///
/// [`blob`](Self::blob) is already synchronous on the async face — a stateless handle needs no I/O
/// to mint — so [`open`](Self::open) is the whole of what a mode can change here. Creating a
/// directory is a syscall that returns; `LocalFsStore::open` was always spelled that way, and this
/// seam is where the shipped store stops wrapping that fact in an `async fn`.
pub trait BlobStore: Sized {
  /// How to open the connection-manager — a root directory, client options.
  type Options;
  /// An open failure.
  type Error;
  /// The stateless per-slot handle produced — its `Connection` is `Self`.
  type Handle;

  /// Open the connection-manager ONCE, on this thread.
  ///
  /// # Errors
  ///
  /// [`Error`](Self::Error) where the store cannot be opened.
  fn open(options: Self::Options) -> Result<Self, Self::Error>;

  /// The stateless handle for blob slot `slot` — the artifact family (`thumbnail`, `waveform`, …),
  /// the FIRST segment of a blob's hierarchical object name.
  fn blob(&self, slot: impl Into<Utf8Bytes>) -> Self::Handle;
}

/// The unused blob face.
///
/// FULLY UNBOUNDED over `R`, unlike a face whose reads put the key in their output: `get` yields
/// [`Payload`](AsyncBlobEngine::Payload) and no `R::Key` appears in any return, so nothing forces a
/// block-level bound. `get`'s `&R::Key` parameter is named through the method's own
/// `where R: Transformer`, repeated from the trait, and `put` ignores the record entirely.
///
/// Every method spells its context parameter as the GAT PROJECTION inside the wrapper —
/// `Connected<'_, Self::Connection, Self::WriteContext<'_>>` — and NOT as the resolved
/// `Connected<'_, (), ()>`. A GAT scope combined with an RPITIT async return rejects the concrete
/// spelling with `E0195`, a method-lifetime mismatch against the trait. The projection form is the
/// one that compiles, and a real borrowing impl writes it the same way.
impl<R> AsyncBlobEngine<R> for () {
  type Options = ();
  type Error = Infallible;
  /// An empty buffer — the unused face stores nothing, so it has nothing to hand back.
  type Payload = Vec<u8>;
  type Connection = ();
  type ReadContext<'a> = ();
  type WriteContext<'a> = ();

  #[inline(always)]
  fn put(
    &self,
    _ctx: Connected<'_, Self::Connection, Self::WriteContext<'_>>,
    _record: &R,
  ) -> impl Future<Output = Result<(), Self::Error>> + Send {
    ready(Ok(()))
  }

  #[inline(always)]
  fn get(
    &self,
    _ctx: Connected<'_, Self::Connection, Self::ReadContext<'_>>,
    _key: &R::Key,
  ) -> impl Future<Output = Result<Self::Payload, Self::Error>> + Send
  where
    R: Transformer,
  {
    ready(Ok(Vec::new()))
  }

  /// [`None`], because the unused face stores nothing and the widened answer has a word for exactly
  /// that. It is the honest reading rather than an empty buffer: a face that never wrote an object
  /// has none to hand back, which is what absence-as-a-value is for.
  #[inline(always)]
  fn read(
    &self,
    _ctx: Connected<'_, Self::Connection, Self::ReadContext<'_>>,
    _key: &R::Key,
    _suffix: Option<&str>,
  ) -> impl Future<Output = Result<Option<Self::Payload>, Self::Error>> + Send
  where
    R: Transformer,
  {
    ready(Ok(None))
  }
}

/// The unused blob face, in the other mode.
///
/// It exists for the same reason its async sibling does — a resident is generic over its store and
/// the absence of one has to be a TYPE — and it is written out rather than bridged from that
/// sibling: a blocking deployment that names `()` must not have to reach an async trait to say it
/// stores nothing.
impl<R> BlobEngine<R> for () {
  type Options = ();
  type Error = Infallible;
  /// An empty buffer — the unused face stores nothing, so it has nothing to hand back.
  type Payload = Vec<u8>;
  type Connection = ();
  type ReadContext<'a> = ();
  type WriteContext<'a> = ();

  #[inline(always)]
  fn put(
    &self,
    _ctx: Connected<'_, Self::Connection, Self::WriteContext<'_>>,
    _record: &R,
  ) -> Result<(), Self::Error> {
    Ok(())
  }

  #[inline(always)]
  fn get(
    &self,
    _ctx: Connected<'_, Self::Connection, Self::ReadContext<'_>>,
    _key: &R::Key,
  ) -> Result<Self::Payload, Self::Error>
  where
    R: Transformer,
  {
    Ok(Vec::new())
  }

  /// [`None`], for the async face's reason at the mode that holds the act.
  #[inline(always)]
  fn read(
    &self,
    _ctx: Connected<'_, Self::Connection, Self::ReadContext<'_>>,
    _key: &R::Key,
    _suffix: Option<&str>,
  ) -> Result<Option<Self::Payload>, Self::Error>
  where
    R: Transformer,
  {
    Ok(None)
  }
}

#[cfg(test)]
mod tests;