blockworks-foundation
/
fixed
mirror of https://github.com/blockworks-foundation/fixed.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

version 1.2.0

This commit is contained in:
Trevor Spiteri 2020-09-02 13:50:04 +02:00
parent 5e8c87c43a
commit 1b5a5b39ae
4 changed files with 42 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Cargo.toml
View File

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

84
README.md
View File

@ -78,13 +78,14 @@ The conversions supported cover the following cases.
## What’s new ## What’s new
### Version 1.2.0 news (unreleased) ### Version 1.2.0 news (2020-09-02)
* The [`const_fixed_from_int!`][cffi-1-2] macro was added to make it * The [`const_fixed_from_int!`][cffi-1-2] macro was added to make it
easy to define constant fixed-point numbers using integer easy to define constant fixed-point numbers using integer
expressions. expressions ([issue 20]).
[cffi-1-2]: https://tspiteri.gitlab.io/fixed/dev/fixed/macro.const_fixed_from_int.html [cffi-1-2]: https://docs.rs/fixed/~1.2/fixed/macro.const_fixed_from_int.html
[issue 20]: https://gitlab.com/tspiteri/fixed/-/issues/20
### Version 1.1.0 news (2020-07-21) ### Version 1.1.0 news (2020-07-21)
@ -97,23 +98,6 @@ The conversions supported cover the following cases.
[feat-nt-1-1]: https://docs.rs/fixed/~1.1/fixed/#experimental-optional-features [feat-nt-1-1]: https://docs.rs/fixed/~1.1/fixed/#experimental-optional-features
[fof-1-1]: https://docs.rs/fixed/~1.1/fixed/traits/trait.FixedOptionalFeatures.html [fof-1-1]: https://docs.rs/fixed/~1.1/fixed/traits/trait.FixedOptionalFeatures.html
### 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:
* [`from_be_bytes`][f-fbb-1-0], [`from_le_bytes`][f-flb-1-0],
[`from_ne_bytes`][f-fnb-1-0]
* [`to_be_bytes`][f-tbb-1-0], [`to_le_bytes`][f-tlb-1-0],
[`to_ne_bytes`][f-tnb-1-0]
* All deprecated items were removed.
[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 ### Other releases
Details on other releases can be found in [*RELEASES.md*]. Details on other releases can be found in [*RELEASES.md*].
@ -182,7 +166,7 @@ it in your crate, add it as a dependency inside [*Cargo.toml*]:
```toml ```toml
[dependencies] [dependencies]
fixed = "1.1" fixed = "1.2"
``` ```
The *fixed* crate requires rustc version 1.44.0 or later. The *fixed* crate requires rustc version 1.44.0 or later.
@ -207,7 +191,7 @@ To enable features, you can add the dependency like this to
```toml ```toml
[dependencies.fixed] [dependencies.fixed]
version = "1.1" version = "1.2"
features = ["f16", "serde"] features = ["f16", "serde"]
``` ```
@ -253,40 +237,40 @@ additional terms or conditions.
[`Binary`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Binary.html [`Binary`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Binary.html
[`Display`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Display.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 [`Error`]: https://doc.rust-lang.org/nightly/std/error/trait.Error.html
[`FixedI128`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedI128.html [`FixedI128`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI128.html
[`FixedI16`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedI16.html [`FixedI16`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI16.html
[`FixedI32`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedI32.html [`FixedI32`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html
[`FixedI64`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedI64.html [`FixedI64`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI64.html
[`FixedI8`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedI8.html [`FixedI8`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI8.html
[`FixedU128`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedU128.html [`FixedU128`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedU128.html
[`FixedU16`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedU16.html [`FixedU16`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedU16.html
[`FixedU32`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedU32.html [`FixedU32`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedU32.html
[`FixedU64`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedU64.html [`FixedU64`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedU64.html
[`FixedU8`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedU8.html [`FixedU8`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedU8.html
[`FromFixed`]: https://docs.rs/fixed/~1.1/fixed/traits/trait.FromFixed.html [`FromFixed`]: https://docs.rs/fixed/~1.2/fixed/traits/trait.FromFixed.html
[`FromStr`]: https://doc.rust-lang.org/nightly/core/str/trait.FromStr.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 [`From`]: https://doc.rust-lang.org/nightly/core/convert/trait.From.html
[`I20F12`]: https://docs.rs/fixed/~1.1/fixed/types/type.I20F12.html [`I20F12`]: https://docs.rs/fixed/~1.2/fixed/types/type.I20F12.html
[`I4F12`]: https://docs.rs/fixed/~1.1/fixed/types/type.I4F12.html [`I4F12`]: https://docs.rs/fixed/~1.2/fixed/types/type.I4F12.html
[`I4F4`]: https://docs.rs/fixed/~1.1/fixed/types/type.I4F4.html [`I4F4`]: https://docs.rs/fixed/~1.2/fixed/types/type.I4F4.html
[`Into`]: https://doc.rust-lang.org/nightly/core/convert/trait.Into.html [`Into`]: https://doc.rust-lang.org/nightly/core/convert/trait.Into.html
[`LosslessTryFrom`]: https://docs.rs/fixed/~1.1/fixed/traits/trait.LosslessTryFrom.html [`LosslessTryFrom`]: https://docs.rs/fixed/~1.2/fixed/traits/trait.LosslessTryFrom.html
[`LosslessTryInto`]: https://docs.rs/fixed/~1.1/fixed/traits/trait.LosslessTryInto.html [`LosslessTryInto`]: https://docs.rs/fixed/~1.2/fixed/traits/trait.LosslessTryInto.html
[`LossyFrom`]: https://docs.rs/fixed/~1.1/fixed/traits/trait.LossyFrom.html [`LossyFrom`]: https://docs.rs/fixed/~1.2/fixed/traits/trait.LossyFrom.html
[`LossyInto`]: https://docs.rs/fixed/~1.1/fixed/traits/trait.LossyInto.html [`LossyInto`]: https://docs.rs/fixed/~1.2/fixed/traits/trait.LossyInto.html
[`LowerHex`]: https://doc.rust-lang.org/nightly/core/fmt/trait.LowerHex.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 [`Octal`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Octal.html
[`ParseFixedError`]: https://docs.rs/fixed/~1.1/fixed/struct.ParseFixedError.html [`ParseFixedError`]: https://docs.rs/fixed/~1.2/fixed/struct.ParseFixedError.html
[`ToFixed`]: https://docs.rs/fixed/~1.1/fixed/traits/trait.ToFixed.html [`ToFixed`]: https://docs.rs/fixed/~1.2/fixed/traits/trait.ToFixed.html
[`U12`]: https://docs.rs/fixed/~1.1/fixed/types/extra/type.U12.html [`U12`]: https://docs.rs/fixed/~1.2/fixed/types/extra/type.U12.html
[`U20F12`]: https://docs.rs/fixed/~1.1/fixed/types/type.U20F12.html [`U20F12`]: https://docs.rs/fixed/~1.2/fixed/types/type.U20F12.html
[`UpperHex`]: https://doc.rust-lang.org/nightly/core/fmt/trait.UpperHex.html [`UpperHex`]: https://doc.rust-lang.org/nightly/core/fmt/trait.UpperHex.html
[`bf16`]: https://docs.rs/half/^1/half/struct.bf16.html [`bf16`]: https://docs.rs/half/^1/half/struct.bf16.html
[`checked_from_num`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedI32.html#method.checked_from_num [`checked_from_num`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html#method.checked_from_num
[`f16`]: https://docs.rs/half/^1/half/struct.f16.html [`f16`]: https://docs.rs/half/^1/half/struct.f16.html
[`from_num`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedI32.html#method.from_num [`from_num`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html#method.from_num
[`from_str_binary`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedI32.html#method.from_str_binary [`from_str_binary`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html#method.from_str_binary
[`from_str_hex`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedI32.html#method.from_str_hex [`from_str_hex`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html#method.from_str_hex
[`from_str_octal`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedI32.html#method.from_str_octal [`from_str_octal`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html#method.from_str_octal
[`to_num`]: https://docs.rs/fixed/~1.1/fixed/struct.FixedI32.html#method.to_num [`to_num`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html#method.to_num
[const generics]: https://github.com/rust-lang/rust/issues/44580 [const generics]: https://github.com/rust-lang/rust/issues/44580

7
RELEASES.md
View File

@ -5,14 +5,15 @@ modification, are permitted in any medium without royalty provided the
copyright notice and this notice are preserved. This file is offered copyright notice and this notice are preserved. This file is offered
as-is, without any warranty. --> as-is, without any warranty. -->
Version 1.2.0 (unreleased) Version 1.2.0 (2020-09-02)
========================== ==========================
* The [`const_fixed_from_int!`][cffi-1-2] macro was added to make it * The [`const_fixed_from_int!`][cffi-1-2] macro was added to make it
easy to define constant fixed-point numbers using integer easy to define constant fixed-point numbers using integer
expressions. expressions ([issue 20]).
[cffi-1-2]: https://tspiteri.gitlab.io/fixed/dev/fixed/macro.const_fixed_from_int.html [cffi-1-2]: https://docs.rs/fixed/~1.2/fixed/macro.const_fixed_from_int.html
[issue 20]: https://gitlab.com/tspiteri/fixed/-/issues/20
Version 1.1.0 (2020-07-21) Version 1.1.0 (2020-07-21)
========================== ==========================

6
src/lib.rs
View File

@ -147,7 +147,7 @@ it in your crate, add it as a dependency inside [*Cargo.toml*]:
```toml ```toml
[dependencies] [dependencies]
fixed = "1.1" fixed = "1.2"
``` ```
The *fixed* crate requires rustc version 1.44.0 or later. 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 ```toml
[dependencies.fixed] [dependencies.fixed]
version = "1.1" version = "1.2"
features = ["f16", "serde"] features = ["f16", "serde"]
``` ```
@ -258,7 +258,7 @@ additional terms or conditions.
*/ */
#![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(not(feature = "std"), no_std)]
#![warn(missing_docs)] #![warn(missing_docs)]
#![doc(html_root_url = "https://docs.rs/fixed/~1.0")] #![doc(html_root_url = "https://docs.rs/fixed/~1.2")]
#![doc(test(attr(deny(warnings))))] #![doc(test(attr(deny(warnings))))]
#![cfg_attr(feature = "fail-on-warnings", deny(warnings))] #![cfg_attr(feature = "fail-on-warnings", deny(warnings))]