Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bincode 2 updated documentation #436

Closed
6 of 7 tasks
VictorKoenders opened this issue Nov 9, 2021 · 4 comments
Closed
6 of 7 tasks

Bincode 2 updated documentation #436

VictorKoenders opened this issue Nov 9, 2021 · 4 comments
Assignees
Milestone

Comments

@VictorKoenders
Copy link
Contributor

VictorKoenders commented Nov 9, 2021

Some things that I need to document

@jrose-signal
Copy link

The docs are also currently inconsistent about whether a fixed-size array is encoded with its length or not. I see that that's a configuration option now, so probably both places that mention it need to be updated!

@VictorKoenders VictorKoenders added this to the v2.0 milestone Dec 11, 2021
@5225225
Copy link
Contributor

5225225 commented Jan 8, 2022

https://docs.rs/bincode/2.0.0-beta.0/bincode/de/trait.Decoder.html#tymethod.config

The doc wording here talks about a mutable reference but it gives a &Self::C

@rapiz1
Copy link

rapiz1 commented Jan 19, 2022

What about the migration guide? I'm curious about bincode v2's departure from serde and don't know if I should upgrade. It will be helpful to see documentation and the motivation of bincode v2.

@VictorKoenders
Copy link
Contributor Author

What about the migration guide?

Migrating with serde should be simple, enable the serde feature and use the functions in bincode::serde.

A bigger write-up in #482

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants