From cdc09df65acbcd18aa398d0c5e4b2058d6089dae Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 21 May 2026 13:38:50 +0100 Subject: [PATCH] s/on-the-wire/over-the-wire --- rust/src/events/formats/mod.rs | 12 ++++++------ rust/src/events/mod.rs | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/rust/src/events/formats/mod.rs b/rust/src/events/formats/mod.rs index 5d3e490257..b44fce8082 100644 --- a/rust/src/events/formats/mod.rs +++ b/rust/src/events/formats/mod.rs @@ -13,8 +13,8 @@ * */ -//! On-the-wire representations of Matrix events, parameterised by event format -//! version. +//! Over-the-wire representations of Matrix events, parameterised by event +//! format version. //! //! # Design //! @@ -23,7 +23,7 @@ //! //! We model this with a single [`FormattedEvent`] container that is generic //! over the format-specific tail `E`. Serde `#[serde(flatten)]` merges the -//! common and specific halves into a single JSON object on the wire, while +//! common and specific halves into a single JSON object over the wire, while //! keeping them as distinct structs in Rust. This lets version-agnostic code //! (field getters, the `unsigned` accessor, …) read [`EventCommonFields`] //! directly, and only the small amount of version-aware logic (auth-event @@ -40,8 +40,8 @@ //! //! # Format variants //! -//! Different room versions have different on-the-wire formats, which is tracked -//! by [`crate::room_versions::RoomVersion::event_format`] field. +//! Different room versions have different over-the-wire formats, which is +//! tracked by [`crate::room_versions::RoomVersion::event_format`] field. //! //! Each format struct owns only its version-specific fields and any //! validation/derivation logic; the rest lives in [`EventCommonFields`]. The @@ -82,7 +82,7 @@ pub use v2v3::EventFormatV2V3; pub use v4::EventFormatV4; pub use vmsc4242::EventFormatVMSC4242; -/// A parsed Matrix event in its on-the-wire layout. +/// A parsed Matrix event in its over-the-wire layout. /// /// `E` is the format-specific tail. Code that deserialises a known /// room version picks a concrete `E` (e.g. `FormattedEvent`); diff --git a/rust/src/events/mod.rs b/rust/src/events/mod.rs index 51820afffd..4c96a3a4f3 100644 --- a/rust/src/events/mod.rs +++ b/rust/src/events/mod.rs @@ -27,7 +27,7 @@ //! [`FormattedEvent`] is a generic container parametrised by the //! room-version-specific portion (`EventFormatV1`, `EventFormatV2V3`, //! `EventFormatV4`, `EventFormatVMSC4242`). See [`formats`] for the layout -//! of the on-the-wire JSON and how the room-version-agnostic fields are +//! of the over-the-wire JSON and how the room-version-agnostic fields are //! split from the version-specific ones. //! //! [`Event`] is the `pyclass` exposed to Python. It bundles a fully parsed