Skip to content

Commit df819c4

Browse files
committed
prepare release of serde-reflection 0.5.1
1 parent 3fe061d commit df819c4

File tree

8 files changed

+17
-5
lines changed

8 files changed

+17
-5
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ One difficulty often associated with Serde is that small modifications in Rust m
5959

6060
Thanks to `serde-reflection`, one can now solve this issue simply by committing Serde formats as a file in the version control system (VCS) and adding a non-regression test ([real-life example](https://github.com/diem/diem/tree/main/testsuite/generate-format/tests)).
6161

62+
### Dynamic Introspection of Binary Values
63+
64+
Given a recorded data format, the module `serde-reflection::json_converter` allows dynamic conversions of binary values to JSON or from JSON.
65+
6266
### Language Interoperability
6367

6468
The data formats extracted by `serde-reflection` also serve as basis for code generation with the library and tool [`serde-generate`](serde-generate).

serde-generate-bin/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ rust-version = "1.60"
1515
[dependencies]
1616
serde-generate = { path = "../serde-generate", version = "0.32.0" }
1717
structopt = "0.3.21"
18-
serde-reflection = { path = "../serde-reflection", version = "0.5.0" }
18+
serde-reflection = { path = "../serde-reflection", version = "0.5.1" }
1919
serde_yaml = "0.8.17"
2020

2121
[dev-dependencies]

serde-generate/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ include_dir = { version = "0.6.0", optional = true }
2424
serde = { version = "1.0.126", features = ["derive"] }
2525
textwrap = "0.13.4"
2626
phf = { version = "0.10", features = ["macros"], optional = true }
27-
serde-reflection = { path = "../serde-reflection", version = "0.5.0" }
27+
serde-reflection = { path = "../serde-reflection", version = "0.5.1" }
2828

2929
[dev-dependencies]
3030
alloy-sol-types = "0.8.18"

serde-name/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ thiserror = "1.0.25"
2121
serde = { version = "1.0.126", features = ["derive"] }
2222

2323
[dev-dependencies]
24-
serde-reflection = { path = "../serde-reflection", version = "0.5.0" }
24+
serde-reflection = { path = "../serde-reflection", version = "0.5.1" }

serde-reflection/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "serde-reflection"
3-
version = "0.5.0"
3+
version = "0.5.1"
44
description = "Extract representations of Serde data formats"
55
documentation = "https://docs.rs/serde-reflection"
66
repository = "https://github.com/zefchain/serde-reflection"

serde-reflection/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,14 @@ implement the Serialize and/or Deserialize trait(s) of Serde.
1111
Format descriptions are useful in several ways:
1212
* Stored under version control, formats can be tested to prevent unintended modifications
1313
of binary serialization formats (e.g. by changing variant order).
14+
1415
* Formats can be passed to [`serde-generate`](https://docs.rs/serde-generate)
1516
in order to generate class definitions and provide Serde-compatible binary
1617
serialization in other languages (C++, python, Java, etc).
1718

19+
* Together with the module `json_converter`, formats allow dynamic translation of
20+
binary-serialized values to JSON and from JSON.
21+
1822
## Quick Start
1923

2024
Very often, Serde traits are simply implemented using Serde derive macros. In this case,

serde-reflection/src/lib.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,14 @@
99
//! Format descriptions are useful in several ways:
1010
//! * Stored under version control, formats can be tested to prevent unintended modifications
1111
//! of binary serialization formats (e.g. by changing variant order).
12+
//!
1213
//! * Formats can be passed to [`serde-generate`](https://docs.rs/serde-generate)
1314
//! in order to generate class definitions and provide Serde-compatible binary
1415
//! serialization in other languages (C++, python, Java, etc).
1516
//!
17+
//! * Together with the module `json_converter`, formats allow dynamic translation of
18+
//! binary-serialized values to JSON and from JSON.
19+
//!
1620
//! # Quick Start
1721
//!
1822
//! Very often, Serde traits are simply implemented using Serde derive macros. In this case,

0 commit comments

Comments
 (0)