From b97924cd27c455d3e4d2199958399cd7226fc5ba Mon Sep 17 00:00:00 2001 From: Guillaume Binet Date: Mon, 22 Dec 2025 12:05:05 -0600 Subject: [PATCH 1/2] various doc fixes --- README.md | 6 +++--- derive/README.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 88a3198..b14a9f6 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![](https://img.shields.io/badge/discord-join-5865F2?logo=discord&logoColor=white)](https://discord.com/invite/VkCG7Sb9Kw) -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. +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. A compact encoder / decoder pair that uses a binary zero-fluff encoding scheme. The size of the encoded object will be the same or smaller than the size that @@ -105,6 +105,6 @@ Bincode 2.0 has an MSRV of 1.85.0. Any changes to the MSRV are considered a brea 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`. -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)). +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)). -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/_Encode.rs` and `target/generated/bincode/_Decode.rs` which should get you started. +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/_Encode.rs` and `target/generated/cu_bincode/_Decode.rs` which should get you started. diff --git a/derive/README.md b/derive/README.md index ca3694d..9af8553 100644 --- a/derive/README.md +++ b/derive/README.md @@ -1,8 +1,8 @@ # cu-bincode-derive -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. +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. -The derive crate for cu-bincode. Implements `bincode::Encode` and `bincode::Decode`. +The derive crate for cu-bincode. Implements `cu_bincode::Encode` and `cu_bincode::Decode`. This crate is roughly split into 2 parts: @@ -27,4 +27,4 @@ This is supported by the structs in `src/generate`. The most notable points of t For additional derive testing, see the test cases in `../tests` -For testing purposes, all generated code is outputted to the current `target/generated/bincode` folder, under file name `_Encode.rs` and `_Decode.rs`. This can help with debugging. +For testing purposes, all generated code is outputted to the current `target/generated/cu_bincode` folder, under file name `_Encode.rs` and `_Decode.rs`. This can help with debugging. From a1c0aa6ec55d991895066f5c1ca5ee34b4cd9fff Mon Sep 17 00:00:00 2001 From: Guillaume Binet Date: Mon, 22 Dec 2025 12:06:53 -0600 Subject: [PATCH 2/2] adds copper --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b14a9f6..4fa2a18 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ library. ## Bincode in the Wild +* [copper-rs](https://github.com/copper-project/copper-rs): copper-rs uses Bincode. * [google/tarpc](https://github.com/google/tarpc): Bincode is used to serialize and deserialize networked RPC messages. * [servo/webrender](https://github.com/servo/webrender): Bincode records WebRender API calls for record/replay-style graphics debugging. * [servo/ipc-channel](https://github.com/servo/ipc-channel): IPC-Channel uses Bincode to send structs between processes using a channel-like API.