#serialization #compile-time #version #data #deserialize #immutability #checking

vbs

Version-tagged serialization adaptor with compile-time version checking

5 releases

0.1.7 Oct 22, 2024
0.1.6 Jun 3, 2024
0.1.5 May 29, 2024
0.1.4 Apr 1, 2024
0.1.3 Mar 27, 2024

#658 in Encoding

Download history 639/week @ 2024-09-17 657/week @ 2024-09-24 569/week @ 2024-10-01 504/week @ 2024-10-08 745/week @ 2024-10-15 914/week @ 2024-10-22 883/week @ 2024-10-29 942/week @ 2024-11-05 904/week @ 2024-11-12 1183/week @ 2024-11-19 711/week @ 2024-11-26 1227/week @ 2024-12-03 1004/week @ 2024-12-10 748/week @ 2024-12-17 169/week @ 2024-12-24 135/week @ 2024-12-31

2,332 downloads per month
Used in 2 crates

MIT license

17KB
346 lines

vbs

Provides the following:

  • a trait StaticVersionType for constraining to a version (major.minor) at compile-time.
    • sealed to a struct StaticVersion<const MAJOR: u16, const MINOR: u16>.
    • for the purposes of version enforcement, patch versions are not treated as a type change.
  • a struct Version for runtime operations against a version, without requiring dyn
    • used to [de]serialize a version in a strictly defined and immutable form, so that updates to the serialization format iteself can be a version controlled property.
    • does not include patch level, prerelease identifiers, or build metadata; this is not intended to be a general purpose semver crate.
  • a trait BinarySerializer, an adaptor that can be implemented around any data format that adapts the serde data model.
    • by default, serializes a version prefix before each top-level serialization, and verifies version compatibility when deserializing the serialized message.
    • supports unversioned [de]serialize_no_version operations, which, by default, should simply be the same as calling type.serialize(serializer) for the embedded serializer.
  • implementations against existing data formats

Dependencies

~0.7–1.3MB
~30K SLoC