Skip to content

docs(types): record that the codec macros must precede the mod declarations #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mehmetkr-31 wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −0
Open

docs(types): record that the codec macros must precede the mod declarations #303

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions crates/types/src/codec/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ pub use malachitebft_codec::{Codec, HasEncodedLen};
/// - `$ty`: The message type to encode/decode
/// - `$version_ty`: The version enum type
/// - `$version_val`: The specific version value to use
///
/// Must stay above the `pub mod` declarations at the bottom of this file:
/// `network` reaches this macro through textual scope, not through a path, so
/// moving the module declarations above it — or moving this below them —
/// breaks all 8 invocation sites with `cannot find macro`.
macro_rules! impl_versioned_codec {
($codec_ty:ty, $ty:ty, $version_ty:ty, $version_val:expr) => {
impl malachitebft_codec::Codec<$ty> for $codec_ty {
Expand Down Expand Up @@ -75,6 +80,9 @@ macro_rules! impl_versioned_codec {
/// This is only for persisted data formats that predate version bytes, such as
/// the WAL. Networked types are already versioned and should use
/// `impl_versioned_codec!` instead.
///
/// Same ordering constraint as `impl_versioned_codec!`: `wal` reaches this
/// through textual scope, so it must stay above the `pub mod` declarations.
macro_rules! impl_versioned_codec_with_legacy_fallback {
($codec_ty:ty, $ty:ty, $version_ty:ty, $version_val:expr) => {
impl malachitebft_codec::Codec<$ty> for $codec_ty {
Expand Down