From: Valentine Wallace <vwallace@protonmail.com>
Date: Wed, 23 Aug 2023 15:24:25 +0000 (-0400)
Subject: Document _init_and_read_* ser macro requirements
X-Git-Tag: v0.0.117-alpha1~45^2
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=ea84f2ac73bf321e93fb434733cbc8e66650f42a;p=rust-lightning

Document _init_and_read_* ser macro requirements
---

diff --git a/lightning/src/util/ser_macros.rs b/lightning/src/util/ser_macros.rs
index 4f1fada95..247fdf600 100644
--- a/lightning/src/util/ser_macros.rs
+++ b/lightning/src/util/ser_macros.rs
@@ -791,6 +791,9 @@ macro_rules! _init_tlv_field_var {
 
 /// Equivalent to running [`_init_tlv_field_var`] then [`read_tlv_fields`].
 ///
+/// If any unused values are read, their type MUST be specified or else `rustc` will read them as an
+/// `i64`.
+///
 /// This is exported for use by other exported macros, do not use directly.
 #[doc(hidden)]
 #[macro_export]
@@ -807,6 +810,9 @@ macro_rules! _init_and_read_len_prefixed_tlv_fields {
 }
 
 /// Equivalent to running [`_init_tlv_field_var`] then [`decode_tlv_stream`].
+///
+/// If any unused values are read, their type MUST be specified or else `rustc` will read them as an
+/// `i64`.
 macro_rules! _init_and_read_tlv_stream {
 	($reader: ident, {$(($type: expr, $field: ident, $fieldty: tt)),* $(,)*}) => {
 		$(