version 1.0.0

This commit is contained in:
Trevor Spiteri 2020-06-04 18:59:55 +02:00
parent ef36b4f767
commit fcdd018240
4 changed files with 46 additions and 96 deletions

View File

@ -7,7 +7,7 @@
[package]
name = "fixed"
version = "0.5.7"
version = "1.0.0"
authors = ["Trevor Spiteri <tspiteri@ieee.org>"]
description = "Fixed-point numbers"
documentation = "https://docs.rs/fixed"

120
README.md
View File

@ -78,7 +78,7 @@ The conversions supported cover the following cases.
## Whats new
### Version 1.0.0 news (unreleased)
### Version 1.0.0 news (2020-06-04)
* The crate now requires rustc version 1.44.0 or later.
* The following methods are now `const` functions:
@ -88,62 +88,12 @@ The conversions supported cover the following cases.
[`to_ne_bytes`][f-tnb-1-0]
* All deprecated items were removed.
[f-fbb-1-0]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.from_be_bytes
[f-flb-1-0]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.from_le_bytes
[f-fnb-1-0]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.from_ne_bytes
[f-tbb-1-0]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.to_be_bytes
[f-tlb-1-0]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.to_le_bytes
[f-tnb-1-0]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.to_ne_bytes
### Version 0.5.7 news (2020-05-11)
* The [`LosslessTryFrom`][ltf-0-5-7] and
[`LosslessTryInto`][lti-0-5-7] traits were added.
* The following methods were added to all fixed-point types, to the
[`Fixed`][tf-0-5-7] trait, and to the [`Wrapping`][wr-0-5-7]
wrapper:
* [`leading_ones`][f-lo-0-5-7], [`trailing_ones`][f-to-0-5-7]
* The following method was added to unsigned fixed-point types and
to the [`FixedUnsigned`][tfu-0-5-7] trait:
* [`wrapping_next_power_of_two`][f-wnpot-0-5-7]
* The [`PHI`][phi-0-5-7] and [`FRAC_1_PHI`][f1phi-0-5-7] constants
were added to the [`consts`][cons-0-5-7] module and as
[associated constants][f-phi-0-5-7] for fixed-point types.
[cons-0-5-7]: https://docs.rs/fixed/0.5.7/fixed/consts/index.html
[f-lo-0-5-7]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI32.html#method.leading_ones
[f-phi-0-5-7]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI32.html#associatedconstant.PHI
[f-to-0-5-7]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI32.html#method.trailing_ones
[f-wnpot-0-5-7]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedU32.html#method.wrapping_next_power_of_two
[f1phi-0-5-7]: https://docs.rs/fixed/0.5.7/fixed/consts/constant.FRAC_1_PHI.html
[ltf-0-5-7]: https://docs.rs/fixed/0.5.7/fixed/traits/trait.LosslessTryFrom.html
[lti-0-5-7]: https://docs.rs/fixed/0.5.7/fixed/traits/trait.LosslessTryInto.html
[phi-0-5-7]: https://docs.rs/fixed/0.5.7/fixed/consts/constant.PHI.html
[tf-0-5-7]: https://docs.rs/fixed/0.5.7/fixed/traits/trait.Fixed.html
[tfu-0-5-7]: https://docs.rs/fixed/0.5.7/fixed/traits/trait.FixedUnsigned.html
[wr-0-5-7]: https://docs.rs/fixed/0.5.7/fixed/struct.Wrapping.html
### Version 0.5.6 news (2020-05-01)
* The following methods were added to signed fixed-point types and to
the [`FixedSigned`][tfs-0-5-6] trait:
* [`checked_signum`][f-csig-0-5-6],
[`saturating_signum`][f-ssig-0-5-6],
[`wrapping_signum`][f-wsig-0-5-6],
[`overflowing_signum`][f-osig-0-5-6]
* The [`LossyFrom`][lf-0-5-6] and [`LossyInto`][li-0-5-6] traits
were added to [the prelude][pre-0-5-6].
* Casts deprecated in version 0.3.1 of the *az* crate were marked as
deprecated.
[f-csig-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html#method.checked_signum
[f-osig-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html#method.overflowing_signum
[f-ssig-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html#method.saturating_signum
[f-wsig-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html#method.wrapping_signum
[lf-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/traits/trait.LossyFrom.html
[li-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/traits/trait.LossyInto.html
[pre-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/prelude/index.html
[tfs-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/traits/trait.FixedSigned.html
[f-fbb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_be_bytes
[f-flb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_le_bytes
[f-fnb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_ne_bytes
[f-tbb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.to_be_bytes
[f-tlb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.to_le_bytes
[f-tnb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.to_ne_bytes
### Other releases
@ -213,7 +163,7 @@ it in your crate, add it as a dependency inside [*Cargo.toml*]:
```toml
[dependencies]
fixed = "0.5.7"
fixed = "1"
```
The *fixed* crate requires rustc version 1.44.0 or later.
@ -238,7 +188,7 @@ To enable features, you can add the dependency like this to
```toml
[dependencies.fixed]
version = "0.5.7"
version = "1"
features = ["f16", "serde"]
```
@ -271,40 +221,40 @@ additional terms or conditions.
[`Binary`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Binary.html
[`Display`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html
[`Error`]: https://doc.rust-lang.org/nightly/std/error/trait.Error.html
[`FixedI128`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI128.html
[`FixedI16`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI16.html
[`FixedI32`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI32.html
[`FixedI64`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI64.html
[`FixedI8`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI8.html
[`FixedU128`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedU128.html
[`FixedU16`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedU16.html
[`FixedU32`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedU32.html
[`FixedU64`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedU64.html
[`FixedU8`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedU8.html
[`FromFixed`]: https://docs.rs/fixed/0.5.7/fixed/traits/trait.FromFixed.html
[`FixedI128`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI128.html
[`FixedI16`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI16.html
[`FixedI32`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html
[`FixedI64`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI64.html
[`FixedI8`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI8.html
[`FixedU128`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedU128.html
[`FixedU16`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedU16.html
[`FixedU32`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedU32.html
[`FixedU64`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedU64.html
[`FixedU8`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedU8.html
[`FromFixed`]: https://docs.rs/fixed/~1.0/fixed/traits/trait.FromFixed.html
[`FromStr`]: https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html
[`From`]: https://doc.rust-lang.org/nightly/core/convert/trait.From.html
[`I20F12`]: https://docs.rs/fixed/0.5.7/fixed/types/type.I20F12.html
[`I4F12`]: https://docs.rs/fixed/0.5.7/fixed/types/type.I4F12.html
[`I4F4`]: https://docs.rs/fixed/0.5.7/fixed/types/type.I4F4.html
[`I20F12`]: https://docs.rs/fixed/~1.0/fixed/types/type.I20F12.html
[`I4F12`]: https://docs.rs/fixed/~1.0/fixed/types/type.I4F12.html
[`I4F4`]: https://docs.rs/fixed/~1.0/fixed/types/type.I4F4.html
[`Into`]: https://doc.rust-lang.org/nightly/core/convert/trait.Into.html
[`LosslessTryFrom`]: https://tspiteri.gitlab.io/fixed/dev/fixed/traits/trait.LosslessTryFrom.html
[`LosslessTryInto`]: https://tspiteri.gitlab.io/fixed/dev/fixed/traits/trait.LosslessTryInto.html
[`LossyFrom`]: https://docs.rs/fixed/0.5.7/fixed/traits/trait.LossyFrom.html
[`LossyInto`]: https://docs.rs/fixed/0.5.7/fixed/traits/trait.LossyInto.html
[`LossyFrom`]: https://docs.rs/fixed/~1.0/fixed/traits/trait.LossyFrom.html
[`LossyInto`]: https://docs.rs/fixed/~1.0/fixed/traits/trait.LossyInto.html
[`LowerHex`]: https://doc.rust-lang.org/nightly/core/fmt/trait.LowerHex.html
[`Octal`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Octal.html
[`ParseFixedError`]: https://docs.rs/fixed/0.5.7/fixed/struct.ParseFixedError.html
[`ToFixed`]: https://docs.rs/fixed/0.5.7/fixed/traits/trait.ToFixed.html
[`U12`]: https://docs.rs/fixed/0.5.7/fixed/types/extra/type.U12.html
[`U20F12`]: https://docs.rs/fixed/0.5.7/fixed/types/type.U20F12.html
[`ParseFixedError`]: https://docs.rs/fixed/~1.0/fixed/struct.ParseFixedError.html
[`ToFixed`]: https://docs.rs/fixed/~1.0/fixed/traits/trait.ToFixed.html
[`U12`]: https://docs.rs/fixed/~1.0/fixed/types/extra/type.U12.html
[`U20F12`]: https://docs.rs/fixed/~1.0/fixed/types/type.U20F12.html
[`UpperHex`]: https://doc.rust-lang.org/nightly/core/fmt/trait.UpperHex.html
[`bf16`]: https://docs.rs/half/^1/half/struct.bf16.html
[`checked_from_num`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI32.html#method.checked_from_num
[`checked_from_num`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.checked_from_num
[`f16`]: https://docs.rs/half/^1/half/struct.f16.html
[`from_num`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI32.html#method.from_num
[`from_str_binary`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI32.html#method.from_str_binary
[`from_str_hex`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI32.html#method.from_str_hex
[`from_str_octal`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI32.html#method.from_str_octal
[`to_num`]: https://docs.rs/fixed/0.5.7/fixed/struct.FixedI32.html#method.to_num
[`from_num`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_num
[`from_str_binary`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_str_binary
[`from_str_hex`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_str_hex
[`from_str_octal`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_str_octal
[`to_num`]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.to_num
[const generics]: https://github.com/rust-lang/rust/issues/44580

View File

@ -5,7 +5,7 @@ modification, are permitted in any medium without royalty provided the
copyright notice and this notice are preserved. This file is offered
as-is, without any warranty. -->
Version 1.0.0 (unreleased)
Version 1.0.0 (2020-06-04)
==========================
* The crate now requires rustc version 1.44.0 or later.
@ -16,12 +16,12 @@ Version 1.0.0 (unreleased)
[`to_ne_bytes`][f-tnb-1-0]
* All deprecated items were removed.
[f-fbb-1-0]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.from_be_bytes
[f-flb-1-0]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.from_le_bytes
[f-fnb-1-0]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.from_ne_bytes
[f-tbb-1-0]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.to_be_bytes
[f-tlb-1-0]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.to_le_bytes
[f-tnb-1-0]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.to_ne_bytes
[f-fbb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_be_bytes
[f-flb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_le_bytes
[f-fnb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_ne_bytes
[f-tbb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.to_be_bytes
[f-tlb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.to_le_bytes
[f-tnb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.to_ne_bytes
Version 0.5.7 (2020-05-11)
==========================

View File

@ -147,7 +147,7 @@ it in your crate, add it as a dependency inside [*Cargo.toml*]:
```toml
[dependencies]
fixed = "0.5.7"
fixed = "1"
```
The *fixed* crate requires rustc version 1.44.0 or later.
@ -172,7 +172,7 @@ To enable features, you can add the dependency like this to
```toml
[dependencies.fixed]
version = "0.5.7"
version = "1"
features = ["f16", "serde"]
```
@ -245,7 +245,7 @@ additional terms or conditions.
*/
#![cfg_attr(not(feature = "std"), no_std)]
#![warn(missing_docs)]
#![doc(html_root_url = "https://docs.rs/fixed/0.5.7")]
#![doc(html_root_url = "https://docs.rs/fixed/~1.0")]
#![doc(test(attr(deny(warnings))))]
#![cfg_attr(feature = "fail-on-warnings", deny(warnings))]