Snap for 7213287 from e058ab76821d4635e4ab99da62c3a5629a5e2c37 to tm-release
Change-Id: I14c0b55758b4a1a696a600c22e14e171401c7fdb
diff --git a/.cargo_vcs_info.json b/.cargo_vcs_info.json
new file mode 100644
index 0000000..13f1433
--- /dev/null
+++ b/.cargo_vcs_info.json
@@ -0,0 +1,5 @@
+{
+ "git": {
+ "sha1": "74cec5dcf2014ecfe7cb05837b147cbb4f49024e"
+ }
+}
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..dcc96f3
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+*.rs.bk
+Cargo.lock
+target/*
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..6da2fc0
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,35 @@
+language: rust
+
+matrix:
+ include:
+ # MSRV
+ - env: TARGET=x86_64-unknown-linux-gnu
+ rust: 1.13.0
+
+ # 32-bit
+ - env: TARGET=i686-unknown-linux-musl
+ - env: TARGET=x86_64-unknown-linux-gnu
+
+before_install: set -e
+
+install:
+ - bash ci/install.sh
+
+script:
+ - bash ci/script.sh
+
+after_script: set +e
+
+cache: cargo
+
+before_cache:
+ - chmod -R a+r $HOME/.cargo
+
+branches:
+ only:
+ - staging
+ - trying
+
+notifications:
+ email:
+ on_success: never
diff --git a/Android.bp b/Android.bp
new file mode 100644
index 0000000..ca9a671
--- /dev/null
+++ b/Android.bp
@@ -0,0 +1,22 @@
+// This file is generated by cargo2android.py --run --device --dependencies.
+// Do not modify this file as changes will be overridden on upgrade.
+
+rust_library {
+ name: "libcast",
+ host_supported: true,
+ crate_name: "cast",
+ srcs: ["src/lib.rs"],
+ edition: "2015",
+ features: [
+ "default",
+ "std",
+ ],
+ flags: [
+ "--cfg stable_i128",
+ ],
+}
+
+// dependent_library ["feature_list"]
+// rustc_version-0.2.3
+// semver-0.9.0 "default"
+// semver-parser-0.7.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..eb26758
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,54 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [v0.2.3] - 2018-11-17
+
+### Changed
+
+- Documented the guaranteed MRSV to be 1.13
+- The `x128` feature now works on *stable* Rust 1.26+
+
+### Fixed
+
+- Overflow and underflow checks when casting a float to an unsigned integer
+
+## [v0.2.2] - 2017-05-07
+
+### Fixed
+
+- UB in the checked cast from `f32` to `u128`.
+
+## [v0.2.1] - 2017-05-06
+
+### Added
+
+- Support for 128-bit integers, behind the `x128` Cargo feature (nightly
+ needed).
+
+## [v0.2.0] - 2017-02-08
+
+### Added
+
+- Now `cast::Error` implements the `std::error::Error` trait among other traits
+ like `Display`, `Clone`, etc.
+
+### Changed
+
+- [breaking-change] This crate now depends on the `std` crate by default but you
+ can make it `no_std` by opting out of the `std` Cargo feature.
+
+## v0.1.0 - 2016-02-07
+
+Initial release
+
+[Unreleased]: https://github.com/japaric/cast.rs/compare/v0.2.3...HEAD
+[v0.2.3]: https://github.com/japaric/cast.rs/compare/v0.2.2...v0.2.3
+[v0.2.2]: https://github.com/japaric/cast.rs/compare/v0.2.1...v0.2.2
+[v0.2.1]: https://github.com/japaric/cast.rs/compare/v0.2.0...v0.2.1
+[v0.2.0]: https://github.com/japaric/cast.rs/compare/v0.1.0...v0.2.0
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..40df4af
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,31 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies
+#
+# If you believe there's an error in this file please file an
+# issue against the rust-lang/cargo repository. If you're
+# editing this file be aware that the upstream Cargo.toml
+# will likely look very different (and much more reasonable)
+
+[package]
+name = "cast"
+version = "0.2.3"
+authors = ["Jorge Aparicio <jorge@japaric.io>"]
+build = "build.rs"
+description = "Ergonomic, checked cast functions for primitive types"
+documentation = "https://docs.rs/cast"
+keywords = ["checked", "cast", "primitive", "integer", "float"]
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/japaric/cast.rs"
+[dev-dependencies.quickcheck]
+version = "0.9.0"
+[build-dependencies.rustc_version]
+version = "0.2.3"
+
+[features]
+default = ["std"]
+std = []
+x128 = []
diff --git a/Cargo.toml.orig b/Cargo.toml.orig
new file mode 100644
index 0000000..6e95860
--- /dev/null
+++ b/Cargo.toml.orig
@@ -0,0 +1,25 @@
+[package]
+authors = ["Jorge Aparicio <jorge@japaric.io>"]
+build = "build.rs"
+description = "Ergonomic, checked cast functions for primitive types"
+documentation = "https://docs.rs/cast"
+keywords = ["checked", "cast", "primitive", "integer", "float"]
+license = "MIT OR Apache-2.0"
+name = "cast"
+repository = "https://github.com/japaric/cast.rs"
+version = "0.2.3"
+
+[features]
+# Assume we should use `std` unless asked to do otherwise.
+default = ["std"]
+# Enable this to get a std::error::Error impl for convenient use with other
+# libraries.
+std = []
+# Enable this for i128/u128 support
+x128 = []
+
+[build-dependencies]
+rustc_version = "0.2.3"
+
+[dev-dependencies]
+quickcheck = "0.9.0"
diff --git a/LICENSE b/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
new file mode 100644
index 0000000..16fe87b
--- /dev/null
+++ b/LICENSE-APACHE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/LICENSE-MIT b/LICENSE-MIT
new file mode 100644
index 0000000..3c1a4ea
--- /dev/null
+++ b/LICENSE-MIT
@@ -0,0 +1,25 @@
+Copyright (c) 2014-2017 Jorge Aparicio
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/METADATA b/METADATA
new file mode 100644
index 0000000..201e7db
--- /dev/null
+++ b/METADATA
@@ -0,0 +1,19 @@
+name: "cast"
+description: "Ergonomic, checked cast functions for primitive types"
+third_party {
+ url {
+ type: HOMEPAGE
+ value: "https://crates.io/crates/cast"
+ }
+ url {
+ type: ARCHIVE
+ value: "https://static.crates.io/crates/cast/cast-0.2.3.crate"
+ }
+ version: "0.2.3"
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2020
+ month: 12
+ day: 21
+ }
+}
diff --git a/MODULE_LICENSE_APACHE2 b/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/MODULE_LICENSE_APACHE2
diff --git a/OWNERS b/OWNERS
new file mode 100644
index 0000000..46fc303
--- /dev/null
+++ b/OWNERS
@@ -0,0 +1 @@
+include platform/prebuilts/rust:/OWNERS
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3ed32f1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+[](https://crates.io/crates/cast)
+[](https://crates.io/crates/cast)
+
+# `cast`
+
+> Ergonomic, checked cast functions for primitive types
+
+``` rust
+extern crate cast;
+
+// `u8` and `u16` are checked cast functions, use them to cast from any numeric
+// primitive to `u8`/`u16` respectively
+use cast::{u8, u16, Error};
+
+// Infallible operations, like integer promotion, are equivalent to a normal
+// cast with `as`
+assert_eq!(u16(0u8), 0u16);
+
+// Everything else will return a `Result` depending on the success of the
+// operation
+assert_eq!(u8(0u16), Ok(0u8));
+assert_eq!(u8(256u16), Err(Error::Overflow));
+assert_eq!(u8(-1i8), Err(Error::Underflow));
+assert_eq!(u8(1. / 0.), Err(Error::Infinite));
+assert_eq!(u8(0. / 0.), Err(Error::NaN));
+```
+
+## [API docs](https://docs.rs/cast)
+
+## License
+
+Licensed under either of
+
+- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
+ http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.
diff --git a/build.rs b/build.rs
new file mode 100644
index 0000000..2aa9f5b
--- /dev/null
+++ b/build.rs
@@ -0,0 +1,8 @@
+extern crate rustc_version;
+
+fn main() {
+ let vers = rustc_version::version().unwrap();
+ if vers.major == 1 && vers.minor >= 26 {
+ println!("cargo:rustc-cfg=stable_i128")
+ }
+}
diff --git a/ci/install.sh b/ci/install.sh
new file mode 100644
index 0000000..3c41921
--- /dev/null
+++ b/ci/install.sh
@@ -0,0 +1,9 @@
+set -euxo pipefail
+
+main() {
+ if [ $TARGET != x86_64-unknown-linux-gnu ]; then
+ rustup target add $TARGET
+ fi
+}
+
+main
diff --git a/ci/script.sh b/ci/script.sh
new file mode 100644
index 0000000..12b2619
--- /dev/null
+++ b/ci/script.sh
@@ -0,0 +1,43 @@
+set -euxo pipefail
+
+main() {
+ # not MSRV
+ if [ $TRAVIS_RUST_VERSION != 1.13.0 ]; then
+ cargo check --target $TARGET --no-default-features
+
+ cargo test --features x128 --target $TARGET
+ cargo test --features x128 --target $TARGET --release
+ else
+ cargo build --target $TARGET --no-default-features
+ cargo build --target $TARGET
+ fi
+}
+
+# fake Travis variables to be able to run this on a local machine
+if [ -z ${TRAVIS_BRANCH-} ]; then
+ TRAVIS_BRANCH=staging
+fi
+
+if [ -z ${TRAVIS_PULL_REQUEST-} ]; then
+ TRAVIS_PULL_REQUEST=false
+fi
+
+if [ -z ${TRAVIS_RUST_VERSION-} ]; then
+ case $(rustc -V) in
+ *nightly*)
+ TRAVIS_RUST_VERSION=nightly
+ ;;
+ *beta*)
+ TRAVIS_RUST_VERSION=beta
+ ;;
+ *)
+ TRAVIS_RUST_VERSION=stable
+ ;;
+ esac
+fi
+
+if [ -z ${TARGET-} ]; then
+ TARGET=$(rustc -Vv | grep host | cut -d ' ' -f2)
+fi
+
+main
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..4a8efe9
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,546 @@
+//! Ergonomic, checked cast functions for primitive types
+//!
+//! This crate provides one checked cast function for each numeric primitive.
+//! Use these functions to perform a cast from any other numeric primitive:
+//!
+//! ```
+//! extern crate cast;
+//!
+//! use cast::{u8, u16, Error};
+//!
+//! # fn main() {
+//! // Infallible operations, like integer promotion, are equivalent to a normal
+//! // cast with `as`
+//! assert_eq!(u16(0u8), 0u16);
+//!
+//! // Everything else will return a `Result` depending on the success of the
+//! // operation
+//! assert_eq!(u8(0u16), Ok(0u8));
+//! assert_eq!(u8(256u16), Err(Error::Overflow));
+//! assert_eq!(u8(-1i8), Err(Error::Underflow));
+//! assert_eq!(u8(1. / 0.), Err(Error::Infinite));
+//! assert_eq!(u8(0. / 0.), Err(Error::NaN));
+//! # }
+//! ```
+//!
+//! There are no namespace problems between these functions, the "primitive
+//! modules" in `core`/`std` and the built-in primitive types, so all them can
+//! be in the same scope:
+//!
+//! ```
+//! extern crate cast;
+//!
+//! use std::u8;
+//! use cast::{u8, u16};
+//!
+//! # fn main() {
+//! // `u8` as a type
+//! let x: u8 = 0;
+//! // `u8` as a module
+//! let y = u16(u8::MAX);
+//! // `u8` as a function
+//! let z = u8(y).unwrap();
+//! # }
+//! ```
+//!
+//! The checked cast functionality is also usable with type aliases via the
+//! `cast` static method:
+//!
+//! ```
+//! extern crate cast;
+//!
+//! use std::os::raw::c_ulonglong;
+//! // NOTE avoid shadowing `std::convert::From` - cf. rust-lang/rfcs#1311
+//! use cast::From as _0;
+//!
+//! # fn main() {
+//! assert_eq!(c_ulonglong::cast(0u8), 0u64);
+//! # }
+//! ```
+//!
+//! This crate also provides a `From` trait that can be used, for example,
+//! to create a generic function that accepts any type that can be infallibly
+//! casted to `u32`.
+//!
+//! ```
+//! extern crate cast;
+//!
+//! fn to_u32<T>(x: T) -> u32
+//! // reads as: "where u32 can be casted from T with output u32"
+//! where u32: cast::From<T, Output=u32>,
+//! {
+//! cast::u32(x)
+//! }
+//!
+//! # fn main() {
+//! assert_eq!(to_u32(0u8), 0u32);
+//! assert_eq!(to_u32(1u16), 1u32);
+//! assert_eq!(to_u32(2u32), 2u32);
+//!
+//! // to_u32(-1i32); // Compile error
+//! # }
+//! ```
+//!
+//! ## Minimal Supported Rust Version
+//!
+//! This crate is guaranteed to compile on stable Rust 1.13 and up. It *might* compile on older
+//! versions but that may change in any new patch release.
+//!
+//! ## Building without `std`
+//!
+//! This crate can be used without Rust's `std` crate by declaring it as
+//! follows in your `Cargo.toml`:
+//!
+//! ``` toml
+//! cast = { version = "*", default-features = false }
+//! ```
+
+#![deny(missing_docs)]
+#![deny(warnings)]
+#![allow(const_err)]
+#![cfg_attr(not(feature = "std"), no_std)]
+#![cfg_attr(all(feature = "x128", not(stable_i128)), feature(i128_type, i128))]
+
+#[cfg(feature = "std")]
+extern crate core;
+
+#[cfg(test)]
+#[macro_use]
+extern crate quickcheck;
+
+use core::fmt;
+#[cfg(feature = "std")]
+use std::error;
+
+#[cfg(test)]
+mod test;
+
+/// Cast errors
+#[derive(Clone, Copy, Debug, Eq, PartialEq)]
+pub enum Error {
+ /// Infinite value casted to a type that can only represent finite values
+ Infinite,
+ /// NaN value casted to a type that can't represent a NaN value
+ NaN,
+ /// Source value is greater than the maximum value that the destination type
+ /// can hold
+ Overflow,
+ /// Source value is smaller than the minimum value that the destination type
+ /// can hold
+ Underflow,
+}
+
+impl Error {
+ /// A private helper function that implements `description`, because
+ /// `description` is only available when we have `std` enabled.
+ fn description_helper(&self) -> &str {
+ match *self {
+ Error::Infinite => "Cannot store infinite value in finite type",
+ Error::NaN => "Cannot store NaN in type which does not support it",
+ Error::Overflow => "Overflow during numeric conversion",
+ Error::Underflow => "Underflow during numeric conversion",
+ }
+ }
+}
+
+impl fmt::Display for Error {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ write!(f, "{}", self.description_helper())
+ }
+}
+
+#[cfg(feature = "std")]
+impl error::Error for Error {
+ fn description(&self) -> &str {
+ self.description_helper()
+ }
+}
+
+/// The "cast from" operation
+pub trait From<Src> {
+ /// The result of the cast operation: either `Self` or `Result<Self, Error>`
+ type Output;
+
+ /// Checked cast from `Src` to `Self`
+ fn cast(Src) -> Self::Output;
+}
+
+macro_rules! fns {
+ ($($ty:ident),+) => {
+ $(
+ /// Checked cast function
+ #[inline]
+ pub fn $ty<T>(x: T) -> <$ty as From<T>>::Output
+ where $ty: From<T>
+ {
+ <$ty as From<T>>::cast(x)
+ }
+ )+
+ }
+}
+
+fns!(f32, f64, i8, i16, i32, i64, isize, u8, u16, u32, u64, usize);
+
+#[cfg(feature = "x128")]
+fns!(i128, u128);
+
+/// `$dst` can hold any value of `$src`
+macro_rules! promotion {
+ ($($src:ty => $($dst: ty),+);+;) => {
+ $(
+ $(
+ impl From<$src> for $dst {
+ type Output = $dst;
+
+ #[inline]
+ fn cast(src: $src) -> $dst {
+ src as $dst
+ }
+ }
+ )+
+ )+
+ }
+}
+
+/// `$dst` can hold any positive value of `$src`
+macro_rules! half_promotion {
+ ($($src:ty => $($dst:ty),+);+;) => {
+ $(
+ $(
+ impl From<$src> for $dst {
+ type Output = Result<$dst, Error>;
+
+ #[inline]
+ fn cast(src: $src) -> Self::Output {
+ if src < 0 {
+ Err(Error::Underflow)
+ } else {
+ Ok(src as $dst)
+ }
+ }
+ }
+ )+
+ )+
+ }
+}
+
+/// From an unsigned `$src` to a smaller `$dst`
+macro_rules! from_unsigned {
+ ($($src:ident => $($dst:ident),+);+;) => {
+ $(
+ $(
+ impl From<$src> for $dst {
+ type Output = Result<$dst, Error>;
+
+ #[inline]
+ fn cast(src: $src) -> Self::Output {
+ use core::$dst;
+
+ if src > $dst::MAX as $src {
+ Err(Error::Overflow)
+ } else {
+ Ok(src as $dst)
+ }
+ }
+ }
+ )+
+ )+
+ }
+}
+
+/// From a signed `$src` to a smaller `$dst`
+macro_rules! from_signed {
+ ($($src:ident => $($dst:ident),+);+;) => {
+ $(
+ $(
+ impl From<$src> for $dst {
+ type Output = Result<$dst, Error>;
+
+ #[inline]
+ fn cast(src: $src) -> Self::Output {
+ use core::$dst;
+
+ Err(if src < $dst::MIN as $src {
+ Error::Underflow
+ } else if src > $dst::MAX as $src {
+ Error::Overflow
+ } else {
+ return Ok(src as $dst);
+ })
+ }
+ }
+ )+
+ )+
+ }
+}
+
+/// From a float `$src` to an integer `$dst`
+macro_rules! from_float {
+ ($($src:ident, $usrc:ident => $($dst:ident),+);+;) => {
+ $(
+ $(
+ impl From<$src> for $dst {
+ type Output = Result<$dst, Error>;
+
+ #[inline]
+ fn cast(src: $src) -> Self::Output {
+ use core::{$dst, $src};
+
+ Err(if src != src {
+ Error::NaN
+ } else if src == $src::INFINITY ||
+ src == $src::NEG_INFINITY {
+ Error::Infinite
+ } else if {
+ // we subtract 1 ULP (unit of least precision) here because some
+ // lossy conversions like `u64::MAX as f64` round *up* and we want
+ // to avoid this evaluating to false in that case
+ use core::mem::transmute;
+ let max = unsafe {
+ transmute::<_, $src>(transmute::<_, $usrc>($dst::MAX as $src) - 1)
+ };
+ src > max
+ } {
+ Error::Overflow
+ } else if $dst::MIN == 0 {
+ // when casting to unsigned integer, negative values close to 0 but
+ // larger than 1.0 should be truncated to 0; this behavior matches
+ // casting from a float to a signed integer
+ if src <= -1.0 {
+ Error::Underflow
+ } else {
+ return Ok(src as $dst);
+ }
+ } else if src < $dst::MIN as $src {
+ Error::Underflow
+ } else {
+ return Ok(src as $dst);
+ })
+ }
+ }
+ )+
+ )+
+ }
+}
+
+/// From a float `$src` to an integer `$dst`, where $dst is large enough to contain
+/// all values of `$src`. We can't ever overflow here
+#[cfg(feature = "x128")]
+macro_rules! from_float_dst {
+ ($($src:ident => $($dst:ident),+);+;) => {
+ $(
+ $(
+ impl From<$src> for $dst {
+ type Output = Result<$dst, Error>;
+
+ #[inline]
+ #[allow(unused_comparisons)]
+ fn cast(src: $src) -> Self::Output {
+ use core::{$dst, $src};
+
+ Err(if src != src {
+ Error::NaN
+ } else if src == $src::INFINITY ||
+ src == $src::NEG_INFINITY {
+ Error::Infinite
+ } else if ($dst::MIN == 0) && src <= -1.0 {
+ Error::Underflow
+ } else {
+ return Ok(src as $dst);
+ })
+ }
+ }
+ )+
+ )+
+ }
+}
+
+// PLAY TETRIS! ;-)
+
+#[cfg(target_pointer_width = "32")]
+mod _32 {
+ use {Error, From};
+
+ // Signed
+ promotion! {
+ i8 => f32, f64, i8, i16, i32, isize, i64;
+ i16 => f32, f64, i16, i32, isize, i64;
+ i32 => f32, f64, i32, isize, i64;
+ isize => f32, f64, i32, isize, i64;
+ i64 => f32, f64, i64;
+ }
+
+ half_promotion! {
+ i8 => u8, u16, u32, usize, u64;
+ i16 => u16, u32, usize, u64;
+ i32 => u32, usize, u64;
+ isize => u32, usize, u64;
+ i64 => u64;
+ }
+
+ from_signed! {
+
+ i16 => i8, u8;
+ i32 => i8, i16, u8, u16;
+ isize => i8, i16, u8, u16;
+ i64 => i8, i16, i32, isize, u8, u16, u32, usize;
+ }
+
+ // Unsigned
+ promotion! {
+ u8 => f32, f64, i16, i32, isize, i64, u8, u16, u32, usize, u64;
+ u16 => f32, f64, i32, isize, i64, u16, u32, usize, u64;
+ u32 => f32, f64, i64, u32, usize, u64;
+ usize => f32, f64, i64, u32, usize, u64;
+ u64 => f32, f64, u64;
+ }
+
+ from_unsigned! {
+ u8 => i8;
+ u16 => i8, i16, u8;
+ u32 => i8, i16, i32, isize, u8, u16;
+ usize => i8, i16, i32, isize, u8, u16;
+ u64 => i8, i16, i32, isize, i64, u8, u16, u32, usize;
+ }
+
+ // Float
+ promotion! {
+ f32 => f32, f64;
+ f64 => f64;
+ }
+
+ from_float! {
+ f32, u32 => i8, i16, i32, isize, i64, u8, u16, u32, usize, u64;
+ f64, u64 => i8, i16, i32, isize, i64, u8, u16, u32, usize, u64;
+ }
+}
+
+#[cfg(target_pointer_width = "64")]
+mod _64 {
+ use {Error, From};
+
+ // Signed
+ promotion! {
+ i8 => f32, f64, i8, i16, i32, i64, isize;
+ i16 => f32, f64, i16, i32, i64, isize;
+ i32 => f32, f64, i32, i64, isize;
+ i64 => f32, f64, i64, isize;
+ isize => f32, f64, i64, isize;
+ }
+
+ half_promotion! {
+ i8 => u8, u16, u32, u64, usize;
+ i16 => u16, u32, u64, usize;
+ i32 => u32, u64, usize;
+ i64 => u64, usize;
+ isize => u64, usize;
+ }
+
+ from_signed! {
+
+ i16 => i8, u8;
+ i32 => i8, i16, u8, u16;
+ i64 => i8, i16, i32, u8, u16, u32;
+ isize => i8, i16, i32, u8, u16, u32;
+ }
+
+ // Unsigned
+ promotion! {
+ u8 => f32, f64, i16, i32, i64, isize, u8, u16, u32, u64, usize;
+ u16 => f32, f64, i32, i64, isize, u16, u32, u64, usize;
+ u32 => f32, f64, i64, isize, u32, u64, usize;
+ u64 => f32, f64, u64, usize;
+ usize => f32, f64, u64, usize;
+ }
+
+ from_unsigned! {
+ u8 => i8;
+ u16 => i8, i16, u8;
+ u32 => i8, i16, i32, u8, u16;
+ u64 => i8, i16, i32, i64, isize, u8, u16, u32;
+ usize => i8, i16, i32, i64, isize, u8, u16, u32;
+ }
+
+ // Float
+ promotion! {
+ f32 => f32, f64;
+ f64 => f64;
+ }
+
+ from_float! {
+ f32, u32 => i8, i16, i32, i64, isize, u8, u16, u32, u64, usize;
+ f64, u64 => i8, i16, i32, i64, isize, u8, u16, u32, u64, usize;
+ }
+}
+
+#[cfg(feature = "x128")]
+mod _x128 {
+ use {Error, From};
+
+ // Signed
+ promotion! {
+ i8 => i128;
+ i16 => i128;
+ i32 => i128;
+ i64 => i128;
+ isize => i128;
+ i128 => f32, f64, i128;
+ }
+
+ half_promotion! {
+ i8 => u128;
+ i16 => u128;
+ i32 => u128;
+ i64 => u128;
+ isize => u128;
+ i128 => u128;
+ }
+
+ from_signed! {
+ i128 => i8, i16, i32, i64, isize, u8, u16, u32, u64, usize;
+ }
+
+ // Unsigned
+ promotion! {
+ u8 => i128, u128;
+ u16 => i128, u128;
+ u32 => i128, u128;
+ u64 => i128, u128;
+ usize => i128, u128;
+ u128 => f64, u128;
+ }
+
+ from_unsigned! {
+ u128 => f32, i8, i16, i32, i64, i128, isize, u8, u16, u32, u64, usize;
+ }
+
+ // Float
+ from_float! {
+ f32, u32 => i128;
+ f64, u64 => i128, u128;
+ }
+
+ from_float_dst! {
+ f32 => u128;
+ }
+}
+
+// The missing piece
+impl From<f64> for f32 {
+ type Output = Result<f32, Error>;
+
+ #[inline]
+ fn cast(src: f64) -> Self::Output {
+ use core::{f32, f64};
+
+ if src != src || src == f64::INFINITY || src == f64::NEG_INFINITY {
+ Ok(src as f32)
+ } else if src < f32::MIN as f64 {
+ Err(Error::Underflow)
+ } else if src > f32::MAX as f64 {
+ Err(Error::Overflow)
+ } else {
+ Ok(src as f32)
+ }
+ }
+}
diff --git a/src/test.rs b/src/test.rs
new file mode 100644
index 0000000..6b619ab
--- /dev/null
+++ b/src/test.rs
@@ -0,0 +1,221 @@
+// If `src` can be promoted to `$dst`, then it must be Ok to cast `dst` back to
+// `$src`
+macro_rules! promote_and_back {
+ ($($src:ident => $($dst:ident),+);+;) => {
+ mod demoting_to {
+ $(
+ mod $src {
+ mod from {
+ use From;
+
+ $(
+ quickcheck! {
+ fn $dst(src: $src) -> bool {
+ $src::cast($dst::cast(src)).is_ok()
+ }
+ }
+ )+
+ }
+ }
+ )+
+ }
+ }
+}
+
+#[cfg(target_pointer_width = "32")]
+promote_and_back! {
+ i8 => f32, f64, i16, i32, isize, i64 ;
+ i16 => f32, f64, i32, isize, i64 ;
+ i32 => f32, f64, i64 ;
+ isize => f32, f64, i64 ;
+ i64 => f32, f64 ;
+ u8 => f32, f64, i16, i32, isize, i64, u16, u32, usize, u64;
+ u16 => f32, f64, i32, isize, i64, u32, usize, u64;
+ u32 => f32, f64, i64, u64;
+ usize => f32, f64, i64, u64;
+ u64 => f32, f64 ;
+}
+
+#[cfg(target_pointer_width = "64")]
+promote_and_back! {
+ i8 => f32, f64, i16, i32, i64, isize ;
+ i16 => f32, f64, i32, i64, isize ;
+ i32 => f32, f64, i64, isize ;
+ i64 => f32, f64 ;
+ isize => f32, f64 ;
+ u8 => f32, f64, i16, i32, i64, isize, u16, u32, u64, usize;
+ u16 => f32, f64, i32, i64, isize, u32, u64, usize;
+ u32 => f32, f64, i64, isize, u64, usize;
+ u64 => f32, f64 ;
+ usize => f32, f64 ;
+}
+
+// TODO uncomment this once quickcheck supports Arbitrary for i128/u128
+// https://github.com/BurntSushi/quickcheck/issues/162
+/*#[cfg(feature = "x128")]
+promote_and_back! {
+ i8 => i128 ;
+ i16 => i128 ;
+ i32 => i128 ;
+ isize => i128 ;
+ i64 => i128 ;
+ i128 => f32, f64 ;
+ u8 => i128, u128;
+ u16 => i128, u128;
+ u32 => i128, u128;
+ usize => i128, u128;
+ u64 => i128, u128;
+ u128 => f32, f64 ;
+}*/
+
+// If it's Ok to cast `src` to `$dst`, it must also be Ok to cast `dst` back to
+// `$src`
+macro_rules! symmetric_cast_between {
+ ($($src:ident => $($dst:ident),+);+;) => {
+ mod symmetric_cast_between {
+ $(
+ mod $src {
+ mod and {
+ use quickcheck::TestResult;
+
+ use From;
+
+ $(
+ quickcheck! {
+ fn $dst(src: $src) -> TestResult {
+ if let Ok(dst) = $dst::cast(src) {
+ TestResult::from_bool(
+ $src::cast(dst).is_ok())
+ } else {
+ TestResult::discard()
+ }
+ }
+ }
+ )+
+ }
+ }
+ )+
+ }
+ }
+}
+
+#[cfg(target_pointer_width = "32")]
+symmetric_cast_between! {
+ u8 => i8 ;
+ u16 => i8, i16 ;
+ u32 => i8, i16, i32 ;
+ usize => i8, i16, i32 ;
+ u64 => i8, i16, i32, i64, isize;
+}
+
+#[cfg(target_pointer_width = "64")]
+symmetric_cast_between! {
+ u8 => i8 ;
+ u16 => i8, i16 ;
+ u32 => i8, i16, i32 ;
+ u64 => i8, i16, i32, i64, isize;
+ usize => i8, i16, i32, i64, isize;
+}
+
+// TODO uncomment this once quickcheck supports Arbitrary for i128/u128
+// https://github.com/BurntSushi/quickcheck/issues/162
+/*#[cfg(feature = "x128")]
+symmetric_cast_between! {
+ u128 => i8, i16, i32, isize, i64, i128;
+}*/
+
+macro_rules! from_float {
+ ($($src:ident => $($dst:ident),+);+;) => {
+ $(
+ mod $src {
+ mod inf {
+ mod to {
+ use {Error, From};
+
+ $(
+ #[test]
+ fn $dst() {
+ let _0: $src = 0.;
+ let _1: $src = 1.;
+ let inf = _1 / _0;
+ let neg_inf = -_1 / _0;
+
+ assert_eq!($dst::cast(inf),
+ Err(Error::Infinite));
+ assert_eq!($dst::cast(neg_inf),
+ Err(Error::Infinite));
+ }
+ )+
+ }
+ }
+
+ mod nan {
+ mod to {
+ use {Error, From};
+
+ $(
+ #[test]
+ fn $dst() {
+ let _0: $src = 0.;
+ let nan = _0 / _0;
+
+ assert_eq!($dst::cast(nan),
+ Err(Error::NaN));
+ }
+ )+
+ }
+ }
+ }
+ )+
+ }
+}
+
+from_float! {
+ f32 => i8, i16, i32, i64, isize, u8, u16, u32, u64, usize;
+ f64 => i8, i16, i32, i64, isize, u8, u16, u32, u64, usize;
+}
+
+// TODO uncomment this once quickcheck supports Arbitrary for i128/u128
+// https://github.com/BurntSushi/quickcheck/issues/162
+/*#[cfg(feature = "x128")]
+from_float! {
+ f32 => i128, u128;
+ f64 => i128, u128;
+}*/
+
+#[test]
+#[cfg(feature = "x128")]
+fn test_fl_conversion() {
+ use u128;
+ assert_eq!(u128(42.0f32), Ok(42));
+}
+
+#[test]
+fn gh16() {
+ assert_eq!(super::u64(-0.01_f64), Ok(0));
+ assert_eq!(super::u64(-0.99_f32), Ok(0));
+
+ assert_eq!(super::u32(-0.99_f64), Ok(0));
+ assert_eq!(super::u32(-0.01_f32), Ok(0));
+
+ assert_eq!(super::u64(0.01_f64), Ok(0));
+ assert_eq!(super::u64(0.99_f32), Ok(0));
+
+ assert_eq!(super::u32(0.99_f64), Ok(0));
+ assert_eq!(super::u32(0.01_f32), Ok(0));
+}
+
+#[test]
+fn gh15() {
+ assert_eq!(super::u32(32_f32.exp2()), Err(super::Error::Overflow));
+ assert_eq!(super::u32(32_f64.exp2()), Err(super::Error::Overflow));
+
+ assert_eq!(super::u64(64_f32.exp2()), Err(super::Error::Overflow));
+ assert_eq!(super::u64(64_f64.exp2()), Err(super::Error::Overflow));
+
+ assert_eq!(super::u8(8_f32.exp2()), Err(super::Error::Overflow));
+ assert_eq!(super::u8(8_f64.exp2()), Err(super::Error::Overflow));
+
+ assert_eq!(super::u16(16_f32.exp2()), Err(super::Error::Overflow));
+ assert_eq!(super::u16(16_f64.exp2()), Err(super::Error::Overflow));
+}