Skip to content

Commit 3d50bab

Browse files
Release 2.0.0-rc.1 (#510)
1 parent 1b5c2ab commit 3d50bab

File tree

6 files changed

+20
-20
lines changed

6 files changed

+20
-20
lines changed

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ members = [
66

77
[package]
88
name = "bincode"
9-
version = "2.0.0-beta.3" # remember to update html_root_url and bincode_derive
9+
version = "2.0.0-rc.1" # remember to update html_root_url and bincode_derive
1010
authors = ["Ty Overby <[email protected]>", "Zoey Riordan <[email protected]>", "Victor Koenders <[email protected]>"]
1111
exclude = ["logo.svg", "examples/*", ".gitignore", ".github/"]
1212

@@ -40,7 +40,7 @@ serde_alloc = ["serde_incl/alloc", "alloc"] # alloc
4040
serde_no_std = ["serde_incl"] # no_std
4141

4242
[dependencies]
43-
bincode_derive = { path = "derive", version = "2.0.0-beta.3", optional = true }
43+
bincode_derive = { path = "derive", version = "2.0.0-rc.1", optional = true }
4444
serde_incl = { package = "serde", version = "1.0", default-features = false, optional = true }
4545

4646
# Used for tests

derive/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "bincode_derive"
3-
version = "2.0.0-beta.3" # remember to update bincode
3+
version = "2.0.0-rc.1" # remember to update bincode
44
authors = ["Zoey Riordan <[email protected]>", "Victor Koenders <[email protected]>"]
55
edition = "2021"
66

docs/migration_guide.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Bincode 2 now has an optional dependency on `serde`. You can either use `serde`,
44

55
## From `Options` to `Configuration`
66

7-
Bincode 1 had the [Options](https://docs.rs/bincode/1/bincode/config/trait.Options.html) trait. This has been replaced with the [Configuration](https://docs.rs/bincode/2.0.0-beta/bincode/config/struct.Configuration.html) struct.
7+
Bincode 1 had the [Options](https://docs.rs/bincode/1/bincode/config/trait.Options.html) trait. This has been replaced with the [Configuration](https://docs.rs/bincode/2.0.0-rc/bincode/config/struct.Configuration.html) struct.
88

99
If you're using `Options`, you can change it like this:
1010

@@ -43,10 +43,10 @@ Make sure to include bincode 2 with the `serde` feature enabled.
4343

4444
```toml
4545
[dependencies]
46-
bincode = { version = "2.0.0-beta", features = ["serde"] }
46+
bincode = { version = "2.0.0-rc", features = ["serde"] }
4747

4848
# Optionally you can disable the `derive` feature:
49-
# bincode = { version = "2.0.0-beta", default-features = false, features = ["std", "serde"] }
49+
# bincode = { version = "2.0.0-rc", default-features = false, features = ["std", "serde"] }
5050
```
5151

5252

@@ -68,13 +68,13 @@ Then replace the following functions: (`Configuration` is `bincode::config::lega
6868

6969
```toml,ignore
7070
[dependencies]
71-
bincode = "2.0.0-beta"
71+
bincode = "2.0.0-rc"
7272
7373
# If you need `no_std` with `alloc`:
74-
# bincode = { version = "2.0.0-beta", default-features = false, features = ["derive", "alloc"] }
74+
# bincode = { version = "2.0.0-rc", default-features = false, features = ["derive", "alloc"] }
7575
7676
# If you need `no_std` and no `alloc`:
77-
# bincode = { version = "2.0.0-beta", default-features = false, features = ["derive"] }
77+
# bincode = { version = "2.0.0-rc", default-features = false, features = ["derive"] }
7878
```
7979

8080
Replace or add the following attributes. You are able to use both `serde-derive` and `bincode-derive` side-by-side.
@@ -84,7 +84,7 @@ Replace or add the following attributes. You are able to use both `serde-derive`
8484
|`#[derive(serde::Serialize)]`|`#[derive(bincode::Encode)]`|
8585
|`#[derive(serde::Deserialize)]`|`#[derive(bincode::Decode)]`|
8686

87-
**note:** To implement these traits manually, see the documentation of [Encode](https://docs.rs/bincode/2.0.0-beta/bincode/enc/trait.Encode.html) and [Decode](https://docs.rs/bincode/2.0.0-beta/bincode/de/trait.Decode.html).
87+
**note:** To implement these traits manually, see the documentation of [Encode](https://docs.rs/bincode/2.0.0-rc/bincode/enc/trait.Encode.html) and [Decode](https://docs.rs/bincode/2.0.0-rc/bincode/de/trait.Decode.html).
8888

8989
**note:** For more information on using `bincode-derive` with external libraries, see [below](#bincode-derive-and-libraries).
9090

@@ -105,10 +105,10 @@ Then replace the following functions: (`Configuration` is `bincode::config::lega
105105

106106
Currently not many libraries support the traits `Encode` and `Decode`. There are a couple of options if you want to use `#[derive(bincode::Encode, bincode::Decode)]`:
107107
- Enable the `serde` feature and add a `#[bincode(with_serde)]` above each field that implements `serde::Serialize/Deserialize` but not `Encode/Decode`
108-
- Enable the `serde` feature and wrap your field in [bincode::serde::Compat](https://docs.rs/bincode/2.0.0-beta/bincode/serde/struct.Compat.html) or [bincode::serde::BorrowCompat](https://docs.rs/bincode/2.0.0-beta/bincode/serde/struct.BorrowCompat.html)
108+
- Enable the `serde` feature and wrap your field in [bincode::serde::Compat](https://docs.rs/bincode/2.0.0-rc/bincode/serde/struct.Compat.html) or [bincode::serde::BorrowCompat](https://docs.rs/bincode/2.0.0-rc/bincode/serde/struct.BorrowCompat.html)
109109
- Make a pull request to the library:
110110
- Make sure to be respectful, most of the developers are doing this in their free time.
111-
- Add a dependency `bincode = { version = "2.0.0-beta", default-features = false, optional = true }` to the `Cargo.toml`
112-
- Implement [Encode](https://docs.rs/bincode/2.0.0-beta/bincode/enc/trait.Encode.html)
113-
- Implement [Decode](https://docs.rs/bincode/2.0.0-beta/bincode/de/trait.Decode.html)
111+
- Add a dependency `bincode = { version = "2.0.0-rc", default-features = false, optional = true }` to the `Cargo.toml`
112+
- Implement [Encode](https://docs.rs/bincode/2.0.0-rc/bincode/enc/trait.Encode.html)
113+
- Implement [Decode](https://docs.rs/bincode/2.0.0-rc/bincode/de/trait.Decode.html)
114114
- Make sure both of these implementations have a `#[cfg(feature = "bincode")]` attribute.

docs/spec.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ Encoding an unsigned integer v (of any type excepting u8/i8) works as follows:
4040

4141
`usize` is being encoded/decoded as a `u64` and `isize` is being encoded/decoded as a `i64`.
4242

43-
See the documentation of [VarintEncoding](https://docs.rs/bincode/2.0.0-beta/bincode/config/struct.Configuration.html#method.with_variable_int_encoding) for more information.
43+
See the documentation of [VarintEncoding](https://docs.rs/bincode/2.0.0-rc/bincode/config/struct.Configuration.html#method.with_variable_int_encoding) for more information.
4444

4545
### FixintEncoding
4646

4747
- Fixed size integers are encoded directly
4848
- Enum discriminants are encoded as u32
4949
- Lengths and usize are encoded as u64
5050

51-
See the documentation of [FixintEncoding](https://docs.rs/bincode/2.0.0-beta/bincode/config/struct.Configuration.html#method.with_fixed_int_encoding) for more information.
51+
See the documentation of [FixintEncoding](https://docs.rs/bincode/2.0.0-rc/bincode/config/struct.Configuration.html#method.with_fixed_int_encoding) for more information.
5252

5353
## Enums
5454

fuzz/Cargo.lock

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
//! [`net::TcpStream`]: std::net::TcpStream
7272
//!
7373
74-
#![doc(html_root_url = "https://docs.rs/bincode/2.0.0-beta.3")]
74+
#![doc(html_root_url = "https://docs.rs/bincode/2.0.0-rc.1")]
7575
#![crate_name = "bincode"]
7676
#![crate_type = "rlib"]
7777

0 commit comments

Comments
 (0)