release-crate-docs: crate docs final pass — doc gate green with -D warnings posture recorded in AGENTS.md, warn(missing_docs) adopted on the four published crates (audit probe 0; Error enum+fields, sqlite substrate fuzz-surface fns filled), accuracy pass fixed core drifts (trim_to wake nuance, ADR-023 §2 domain rules + shared paragraph, QueueOpts gloss, MemStore::new exception) and engine postures (eleven-vs-ten tx-method count, spawn_blocking rationale via sync substrate, one-host cross-process honesty element), spec-side aligned (pg locks family + row-backed wording, mem clock-accessor home), two boundary-wording dispositions recorded for release-contract-window-close (try_recv arms, 8000-byte <= reading), queue round-trip doctest landed in alkstore-mem crate docs; task -> completed with Notes + Summary
This commit is contained in:
1 parent
5f5f6741d5
commit
8e27f4b64b
22 files changed
+289
-49
No files matched your search
@@ -34,6 +34,11 @@
|
||||
//! module's bootstrap the DDL ground. The verification backlog's pg
|
||||
//! column (the ADR-022 contract suite rows this engine owns) runs in
|
||||
//! this crate's `contract_suite` test target.
|
||||
//!
|
||||
//! Every public item carries doc text; the missing-docs lint is part
|
||||
//! of the standing gates.
|
||||
|
||||
#![warn(missing_docs)]
|
||||
|
||||
mod forwarder;
|
||||
mod lock;
|
||||
|
||||
@@ -35,7 +35,8 @@ pub(crate) const LISTENER_APPLICATION_NAME: &str = "alkstore-pg-listener";
|
||||
/// are `open`'s first argument (the tokio-postgres
|
||||
/// [`Config`](::tokio_postgres::Config)-parseable form, ADR-008 §6's
|
||||
/// `open(url, PgOpts)` pin); the engine never invents defaults for
|
||||
/// them. `open` fails with [`Error::Database`] if the config is
|
||||
/// them. `open` fails with
|
||||
/// [`Error::Database`](alkstore::Error::Database) if the config is
|
||||
/// unparseable or the server unreachable. TLS: the engine hardwires
|
||||
/// `NoTls` on every connection path regardless of the config's
|
||||
/// sslmode — v1 TLS is a post-v1 deployment concern
|
||||
@@ -54,7 +55,8 @@ pub struct PgOpts {
|
||||
/// Default [`DEFAULT_MAX_SIZE`] = 8 (the deployment matrix's
|
||||
/// budget line; the listener adds +1 per LISTEN-ing process
|
||||
/// *outside* the pool — sizing rule `max_size + 1`). A value of
|
||||
/// `0` fails [`open`](crate::open) with [`Error::Database`]
|
||||
/// `0` fails [`open`](crate::open) with
|
||||
/// [`Error::Database`](alkstore::Error::Database)
|
||||
/// immediately (validated at entry — no round trip; deadpool
|
||||
/// cannot grant checkouts from an empty pool).
|
||||
pub max_size: usize,
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
//! The transactional seam's pg arm (ADR-007) — `begin_tx`, the
|
||||
//! [`PgTxHandle`] (the pooled-object handle), and all eleven `*_tx`
|
||||
//! methods (`pg-engine-seam-tx`).
|
||||
//! [`PgTxHandle`] (the pooled-object handle), and all eleven
|
||||
//! transaction-handle methods (ten `*_tx` ops plus `commit`). (`pg-engine-seam-tx`).
|
||||
//!
|
||||
//! # No bridge, no `spawn_blocking`
|
||||
//!
|
||||
|
||||
Reference in new issue
Block a user