This is an automated email from the ASF dual-hosted git repository. hubcio pushed a commit to branch feat/message-bus-transports in repository https://gitbox.apache.org/repos/asf/iggy.git
commit eb9f01b5bb20beb67ebb5fff5292fb79674d07c1 Author: Hubert Gruszecki <[email protected]> AuthorDate: Fri Apr 24 12:11:22 2026 +0200 docs(message_bus): name the Transport trait surface in lib.rs (P1-T5) Phase 1 closes out by pointing the crate-level rustdoc at the `transports` module so readers landing on the crate doc without context learn that TCP, WS, and QUIC all live behind a common trait family (`TransportListener`, `TransportConn`, `TransportReader`, `TransportWriter`). Names the TCP impl at `transports::tcp`, the generic install entries `install_replica_conn` / `install_client_conn`, and the generic drain loop `writer_task::run_transport`. No behavior change; docs only. `cargo doc --no-deps` green (the pre-existing `MessageBusConfig::default` intra-doc warning in `connector.rs` is untouched). --- core/message_bus/src/lib.rs | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/core/message_bus/src/lib.rs b/core/message_bus/src/lib.rs index daf52fd83..9d95cc63e 100644 --- a/core/message_bus/src/lib.rs +++ b/core/message_bus/src/lib.rs @@ -56,6 +56,17 @@ //! - 0-RTT stays disabled by default on any future QUIC path. Per- //! command opt-in requires a checked-in idempotence audit. //! +//! # Transport abstraction +//! +//! [`transports`] defines the trait surface every wire plane sits +//! behind: [`transports::TransportListener`], +//! [`transports::TransportConn`], [`transports::TransportReader`], +//! [`transports::TransportWriter`]. TCP is the only production impl +//! (see [`transports::tcp`]); [`installer::install_replica_conn`] / +//! [`installer::install_client_conn`] and +//! [`writer_task::run_transport`] are generic over it so WS / QUIC +//! plug in behind the same registry, fencing, and batching logic. +//! //! The full invariant list and the transport-plan design notes live //! under `Documents/silverhand/iggy/message_bus/transport-plan/`.
