mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-25 07:17:40 +01:00
Code Issues Projects Releases Packages Wiki Activity

Document some TLV write/read formats

Browse source 
While we don't want to publicly document these and support them for
downstream crates, documenting them internally is useful.
This commit is contained in:
Matt Corallo 2023-07-10 22:24:31 +00:00
parent 907ea200f0
commit d83390c63b
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
lightning/src/util/ser_macros.rs
View file

@ -13,6 +13,21 @@
//! [`Readable`]: crate::util::ser::Readable
//! [`Writeable`]: crate::util::ser::Writeable
// There are quite a few TLV serialization "types" which behave differently. We currently only
// publicly document the `optional` and `required` types, not supporting anything else publicly and
// changing them at will.
//
// Some of the other types include:
// * (default_value, $default) - reads optionally, reading $default if no TLV is present
// * (static_value, $value) - ignores any TLVs, always using $value
// * required_vec - reads into a Vec without a length prefix, failing if no TLV is present.
// * optional_vec - reads into an Option<Vec> without a length prefix, continuing if no TLV is
// present. Writes from a Vec directly, only if any elements are present. Note
// that the struct deserialization macros return a Vec, not an Option.
// * upgradable_option - reads via MaybeReadable.
// * upgradable_required - reads via MaybeReadable, requiring a TLV be present but may return None
// if MaybeReadable::read() returns None.
/// Implements serialization for a single TLV record.
/// This is exported for use by other exported macros, do not use directly.
#[doc(hidden)]