Skip to content

Commit 3c9c7a5

Browse files
committed
Move Postcard link up to Bincode spot
Bincode has been in prerelease limbo for nearly a year and the readme does not mention anything related to Serde, so it is not serving as a good first link to a Serde binary format.
1 parent 11faf35 commit 3c9c7a5

File tree

5 files changed

+7
-10
lines changed

5 files changed

+7
-10
lines changed

_src/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ The following is a partial list of data formats that have been implemented for
4343
Serde by the community.
4444

4545
- [JSON], the ubiquitous JavaScript Object Notation used by many HTTP APIs.
46-
- [Bincode], a compact binary format used for IPC within the Servo rendering
47-
engine.
46+
- [Postcard], a no\_std and embedded-systems friendly compact binary format.
4847
- [CBOR], a Concise Binary Object Representation designed for small message size
4948
without the need for version negotiation.
5049
- [YAML], a self-proclaimed human-friendly configuration language that ain't
@@ -57,7 +56,6 @@ Serde by the community.
5756
- [Avro], a binary format used within Apache Hadoop, with support for schema
5857
definition.
5958
- [JSON5], a superset of JSON including some productions from ES5.
60-
- [Postcard], a no\_std and embedded-systems friendly compact binary format.
6159
- [URL] query strings, in the x-www-form-urlencoded format.
6260
- [Envy], a way to deserialize environment variables into Rust structs.
6361
*(deserialization only)*
@@ -75,7 +73,7 @@ Serde by the community.
7573
*(deserialization only)*
7674

7775
[JSON]: https://github.com/serde-rs/json
78-
[Bincode]: https://github.com/bincode-org/bincode
76+
[Postcard]: https://github.com/jamesmunns/postcard
7977
[CBOR]: https://github.com/enarx/ciborium
8078
[YAML]: https://github.com/dtolnay/serde-yaml
8179
[MessagePack]: https://github.com/3Hren/msgpack-rust
@@ -86,7 +84,6 @@ Serde by the community.
8684
[Avro]: https://github.com/flavray/avro-rs
8785
[JSON5]: https://github.com/callum-oakley/json5-rs
8886
[URL]: https://docs.rs/serde_qs
89-
[Postcard]: https://github.com/jamesmunns/postcard
9087
[Envy]: https://github.com/softprops/envy
9188
[Envy Store]: https://github.com/softprops/envy-store
9289
[Cargo]: http://doc.crates.io/manifest.html

_src/custom-serialization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ These methods are generic over the serialization format, represented by the
3232
[`Serializer`](https://docs.serde.rs/serde/ser/trait.Serializer.html) and
3333
[`Deserializer`](https://docs.serde.rs/serde/de/trait.Deserializer.html) traits.
3434
For example there is one Serializer type for JSON and a different one for
35-
Bincode.
35+
Postcard.
3636

3737
- [Implementing `Serialize`](impl-serialize.md)
3838
- [Implementing `Deserialize`](impl-deserialize.md)

_src/deserialize-struct.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ map](deserialize-map.md) in order to avoid allocating a String to hold the field
1919
names. Instead there is a `Field` enum which is deserialized from a `&str`.
2020

2121
The implementation supports two possible ways that a struct may be represented
22-
by a data format: as a seq like in Bincode, and as a map like in JSON.
22+
by a data format: as a seq like in Postcard, and as a map like in JSON.
2323

2424
!PLAYGROUND 2e212d29e38110fc3d8f22ff920712be
2525
```rust

_src/impl-deserialize.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ kinds of deserialization.
4646
`Deserializer::deserialize_any`.
4747

4848
2. The various other `deserialize_*` methods. Non-self-describing formats like
49-
Bincode need to be told what is in the input in order to deserialize it. The
49+
Postcard need to be told what is in the input in order to deserialize it. The
5050
`deserialize_*` methods are hints to the deserializer for how to interpret
5151
the next piece of input. Non-self-describing formats are not able to
5252
deserialize something like `serde_json::Value` which relies on
@@ -56,7 +56,7 @@ When implementing `Deserialize`, you should avoid relying on
5656
`Deserializer::deserialize_any` unless you need to be told by the Deserializer
5757
what type is in the input. Know that relying on `Deserializer::deserialize_any`
5858
means your data type will be able to deserialize from self-describing formats
59-
only, ruling out Bincode and many others.
59+
only, ruling out Postcard and many others.
6060

6161
## The Visitor trait
6262

_src/impl-deserializer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ indicate what Serde data model type the `Deserialize` type expects to see in the
1313
input. For self-describing formats like JSON, it is fine for the `Deserializer`
1414
to ignore this hint and just call whichever `Visitor` method corresponds to the
1515
content of the input data. Other formats, especially compact binary formats like
16-
Bincode, rely on the hint to determine how the input data is to be interpreted.
16+
Postcard, rely on the hint to determine how the input data is to be interpreted.
1717

1818
Self-describing formats can save a lot of code by using the
1919
[`forward_to_deserialize_any!`] macro to ignore hints and forward some or all of

0 commit comments

Comments
 (0)