Module runtime 

Transports, the analytic ladder, and the substrate runtime::Error.

Distinct from the crate-root Error, which is the regex face’s refusal vocabulary. Analytic/search callers use runtime::Error. Transports, the fallback ladder, and the crate’s typed failures.

Every face of this crate asks its question here, and runtime decides how it gets answered:

tier	when
[plane] — the in-process analytic C ABI	the symbols are present and the schema digest agrees
[relay] — the certified CLIs, NDJSON in	always; the fail-open floor
[shell] / [session] — the exact plane’s process + resident transports	the rg-parity search surface

The ladder is fail-open by construction. IRGX_STALE is a declinature, not a failure: the tier is saying “ask the next one and you will get the same answer”, so it never reaches the caller as an Err. The same is true of an absent analytic symbol — an engine built before the analytic plane landed simply has no in-process plane, and the crate keeps working.

Exactly two things are loud. A schema digest mismatch ([Error::SchemaDrift]) means the library’s row tables and this build’s decoder disagree, so falling back would hide a real version skew; and a row that contradicts its own declaration ([Error::Decode]) is corruption, not a miss.

Re-exports

pub use session::Session;

pub use session::default_socket_path;

pub use session::warm_eligible;

pub use answer::Batch;

pub use answer::BatchIter;

pub use answer::RowIter;

pub use answer::Rows;

pub use answer::Stats;

pub use answer::Tier;

pub use cell::OwnedRow;

pub use cell::OwnedValue;

pub use cell::RowSeq;

pub use cell::Texts;

pub use cell::Value;

pub use decode::Row;

Modules

answer

One analytic answer: the cursor its rows are pulled from, the batches they arrive in, and the facts about the answer that no row can carry.

cell

The value model a row is made of — the same seven shapes in a borrowed and an owned form.

decode

The one analytic row decoder, driven by the generated schema table.

handshake

The schema handshake that has to pass before a single native row is decoded.

plane

The in-process analytic plane: the symbol probe, the warm engine cache, and the dispatch that turns a Query into a cursor.

relay

The subprocess tier of the analytic plane — the fail-open floor.

session

Persistent resident-session client — Unix only.

shell

The subprocess transport: locate a certified binary, run it under a wall-clock guard, read its streams.

sys

The raw C-ABI surface, mirroring include/irgx.h symbol-for-symbol.

Structs

CancelToken

A thread-safe request to stop, handed to an in-process analytic query.

Enums

Error

The one error type every fallible call in this crate returns.

Wire

A filled [analytic.params] family, borrowing the request that built it.

Traits

Query

One analytic request, lowered for whichever tier answers it.

Functions

answer

Answer one analytic request, walking the ladder.

struct_size

struct_size for a params family — the fail-closed handshake every [analytic.params] struct opens with.

Type Aliases

Result

Crate-wide Result alias.