clarify msrv support (#375)

* clarify msrv support

* pin byteorder to valid versions
This commit is contained in:
Lena Hellström 2021-02-23 11:47:56 -08:00 committed by GitHub
parent 72d301c284
commit e15b8e911a
2 changed files with 6 additions and 1 deletions

View File

@ -16,7 +16,7 @@ license = "MIT"
description = "A binary serialization / deserialization strategy that uses Serde for transforming structs into bytes and vice versa!" description = "A binary serialization / deserialization strategy that uses Serde for transforming structs into bytes and vice versa!"
[dependencies] [dependencies]
byteorder = "1.3.0" byteorder = ">=1.3.0, < 1.4.0"
serde = "1.0.63" serde = "1.0.63"
[dev-dependencies] [dev-dependencies]

View File

@ -5,6 +5,7 @@
![CI](https://github.com/servo/bincode/workflows/CI/badge.svg) ![CI](https://github.com/servo/bincode/workflows/CI/badge.svg)
[![](https://meritbadge.herokuapp.com/bincode)](https://crates.io/crates/bincode) [![](https://meritbadge.herokuapp.com/bincode)](https://crates.io/crates/bincode)
[![](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![](https://img.shields.io/badge/bincode-rustc_1.18+-lightgray.svg)](https://blog.rust-lang.org/2017/06/08/Rust-1.18.html)
A compact encoder / decoder pair that uses a binary zero-fluff encoding scheme. 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 The size of the encoded object will be the same or smaller than the size that
@ -105,3 +106,7 @@ issues, assuming that the deserialization code for the struct is safe itself.
Bincode can be used for untrusted inputs in the sense that it will not create a Bincode can be used for untrusted inputs in the sense that it will not create a
security issues in your application, provided the configuration is changed to enable a security issues in your application, provided the configuration is changed to enable a
maximum size limit. Malicious inputs will fail upon deserialization. maximum size limit. Malicious inputs will fail upon deserialization.
### What is Bincode's MSRV (minimum supported Rust version)?
Bincode 1.0 maintains support for rust 1.18.0. Any changes to this are considered a breaking change for semver purposes.