Skip to content

Commit c8ebb1c

Browse files
authored
Merge pull request #4 from copper-project/gbin/docfixes
various doc fixes
2 parents 9a9a711 + a1c0aa6 commit c8ebb1c

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
55
[![](https://img.shields.io/badge/discord-join-5865F2?logo=discord&logoColor=white)](https://discord.com/invite/VkCG7Sb9Kw)
66

7-
This is a hard fork of bincode 2.0.1 from crates.io (see first verbatim commit). Do not contact the original authors as per their wishes.
7+
This is a **hard fork of bincode 2 (2.0.1) from crates.io** (see first verbatim commit). Do not contact the original authors as per their wishes.
88

99
A compact encoder / decoder pair that uses a binary zero-fluff encoding scheme.
1010
The size of the encoded object will be the same or smaller than the size that
@@ -21,6 +21,7 @@ library.
2121

2222
## Bincode in the Wild
2323

24+
* [copper-rs](https://github.com/copper-project/copper-rs): copper-rs uses Bincode.
2425
* [google/tarpc](https://github.com/google/tarpc): Bincode is used to serialize and deserialize networked RPC messages.
2526
* [servo/webrender](https://github.com/servo/webrender): Bincode records WebRender API calls for record/replay-style graphics debugging.
2627
* [servo/ipc-channel](https://github.com/servo/ipc-channel): IPC-Channel uses Bincode to send structs between processes using a channel-like API.
@@ -105,6 +106,6 @@ Bincode 2.0 has an MSRV of 1.85.0. Any changes to the MSRV are considered a brea
105106

106107
Bincode will encode enum variants as a `u32`. If you're worried about storage size, we can recommend enabling `Configuration::with_variable_int_encoding()`. This option is enabled by default with the `standard` configuration. In this case enum variants will almost always be encoded as a `u8`.
107108

108-
Currently we have not found a compelling case to respect `#[repr(...)]`. You're most likely trying to interop with a format that is similar-but-not-quite-bincode. We only support our own protocol ([spec](https://github.com/bincode-org/bincode/blob/trunk/docs/spec.md)).
109+
Currently we have not found a compelling case to respect `#[repr(...)]`. You're most likely trying to interop with a format that is similar-but-not-quite-bincode. We only support our own protocol ([spec](https://github.com/copper-project/cu-bincode/blob/main/docs/spec.md)).
109110

110-
If you really want to use bincode to encode/decode a different protocol, consider implementing `Encode` and `Decode` yourself. `bincode-derive` will output the generated implementation in `target/generated/bincode/<name>_Encode.rs` and `target/generated/bincode/<name>_Decode.rs` which should get you started.
111+
If you really want to use bincode to encode/decode a different protocol, consider implementing `Encode` and `Decode` yourself. `cu_bincode_derive` will output the generated implementation in `target/generated/cu_bincode/<name>_Encode.rs` and `target/generated/cu_bincode/<name>_Decode.rs` which should get you started.

derive/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# cu-bincode-derive
22

3-
This is a hard fork of bincode 2.0.1 from crates.io (see first verbatim commit). Do not contact the original authors as per their wishes.
3+
This is a **hard fork of bincode 2 (2.0.1) from crates.io** (see first verbatim commit). Do not contact the original authors as per their wishes.
44

5-
The derive crate for cu-bincode. Implements `bincode::Encode` and `bincode::Decode`.
5+
The derive crate for cu-bincode. Implements `cu_bincode::Encode` and `cu_bincode::Decode`.
66

77
This crate is roughly split into 2 parts:
88

@@ -27,4 +27,4 @@ This is supported by the structs in `src/generate`. The most notable points of t
2727

2828
For additional derive testing, see the test cases in `../tests`
2929

30-
For testing purposes, all generated code is outputted to the current `target/generated/bincode` folder, under file name `<struct/enum name>_Encode.rs` and `<struct/enum name>_Decode.rs`. This can help with debugging.
30+
For testing purposes, all generated code is outputted to the current `target/generated/cu_bincode` folder, under file name `<struct/enum name>_Encode.rs` and `<struct/enum name>_Decode.rs`. This can help with debugging.

0 commit comments

Comments
 (0)