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

[0.1] Disable rustc-serialize derives for future compilers #319

Merged
merged 2 commits into from
Jan 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@ rust:
- nightly
matrix:
include:
- rust: 1.8.0
- rust: 1.19.0
before_script:
# rand 0.3.22 started depending on rand 0.4, which requires rustc 1.15
# manually hacking the lockfile due to the limitations of cargo#2773
- cargo generate-lockfile
- sed -i -e 's/"rand 0.[34].[0-9]\+/"rand 0.3.20/' Cargo.lock
- sed -i -e '/^name = "rand"/,/^$/s/version = "0.3.[0-9]\+"/version = "0.3.20"/' Cargo.lock
- cargo update -p num-integer --precise 0.1.45
- cargo update -p num-traits --precise 0.2.15
- cargo update -p libc --precise 0.2.163
sudo: false
script:
- cargo build --verbose
Expand Down
6 changes: 5 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ categories = [ "algorithms", "data-structures", "science" ]
license = "MIT/Apache-2.0"
name = "num-bigint"
repository = "https://github.com/rust-num/num-bigint"
version = "0.1.44"
version = "0.1.45"
readme = "README.md"
build = "build.rs"

[[bench]]
name = "bigint"
Expand Down Expand Up @@ -52,3 +53,6 @@ version = ">= 0.3.14, < 0.5.0"

[features]
default = ["rand", "rustc-serialize"]

[build-dependencies]
autocfg = "1.4.0"
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![crate](https://img.shields.io/crates/v/num-bigint.svg)](https://crates.io/crates/num-bigint)
[![documentation](https://docs.rs/num-bigint/badge.svg)](https://docs.rs/num-bigint)
![minimum rustc 1.8](https://img.shields.io/badge/rustc-1.8+-red.svg)
![minimum rustc 1.19](https://img.shields.io/badge/rustc-1.19+-red.svg)
[![Travis status](https://travis-ci.org/rust-num/num-bigint.svg?branch=master)](https://travis-ci.org/rust-num/num-bigint)

Big integer types for Rust, `BigInt` and `BigUint`.
Expand All @@ -28,7 +28,7 @@ Release notes are available in [RELEASES.md](RELEASES.md).

## Compatibility

The `num-bigint` crate is tested for rustc 1.8 and greater.
The `num-bigint` crate is tested for rustc 1.19 and greater.

## Alternatives

Expand All @@ -38,7 +38,7 @@ table offers a brief comparison to a few alternatives.

| Crate | License | Min rustc | Implementation |
| :--------------- | :------------- | :-------- | :------------- |
| **`num-bigint`** | MIT/Apache-2.0 | 1.8 | pure rust |
| **`num-bigint`** | MIT/Apache-2.0 | 1.19 | pure rust |
| [`ramp`] | Apache-2.0 | nightly | rust and inline assembly |
| [`rug`] | LGPL-3.0+ | 1.18 | bundles [GMP] via [`gmp-mpfr-sys`] |
| [`rust-gmp`] | MIT | stable? | links to [GMP] |
Expand Down
6 changes: 6 additions & 0 deletions RELEASES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Release 0.1.45

- [Disable `rustc-serialize` derives for future compilers.][319]

[319]: https://github.com/rust-num/num-bigint/pull/319

# Release 0.1.44

- [Division with single-digit divisors is now much faster.][42]
Expand Down
30 changes: 30 additions & 0 deletions build.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
extern crate autocfg;

fn main() {
autocfg::rerun_path("build.rs");
autocfg::emit_possibility(HAS_DERIVE);
if std::env::var_os("CARGO_FEATURE_RUSTC_SERIALIZE").is_some() {
let ac = autocfg::new();

// These built-in derives are being removed! (rust-lang/rust#134272)
//
// It's hard to directly probe for `derive(RustcDecodable, RustcEncodable)`, because that
// depends on the external `rustc-serialize` dependency. They're in `prelude::v1` where we
// can probe by path, but ironically only on relatively new versions, so we're also using
// *inaccessible* `rust_2024` as a proxy for older versions.
if ac.probe_raw(PRELUDE_DERIVE).is_ok() || !ac.probe_path(RUST_2024) {
autocfg::emit(HAS_DERIVE);
} else {
println!("cargo:warning=rustc-serialize is not supported by the current compiler");
}
}
}

const HAS_DERIVE: &str = "has_derive_rustc_serialize";

const PRELUDE_DERIVE: &str = "
#[allow(soft_unstable, deprecated)]
pub use std::prelude::v1::{RustcDecodable, RustcEncodable};
";

const RUST_2024: &str = "std::prelude::rust_2024";
15 changes: 7 additions & 8 deletions ci/rustup.sh
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
#!/bin/sh
# Use rustup to locally run the same suite of tests as .travis.yml.
# (You should first install/update 1.8.0, stable, beta, and nightly.)
# (You should first install/update 1.19.0, stable, beta, and nightly.)

set -ex

export TRAVIS_RUST_VERSION
for TRAVIS_RUST_VERSION in 1.8.0 stable beta nightly; do
for TRAVIS_RUST_VERSION in 1.19.0 stable beta nightly; do
run="rustup run $TRAVIS_RUST_VERSION"
if [ "$TRAVIS_RUST_VERSION" = 1.8.0 ]; then
# rand 0.3.22 started depending on rand 0.4, which requires rustc 1.15
# manually hacking the lockfile due to the limitations of cargo#2773
$run cargo generate-lockfile
$run sed -i -e 's/"rand 0.[34].[0-9]\+/"rand 0.3.20/' Cargo.lock
$run sed -i -e '/^name = "rand"/,/^$/s/version = "0.3.[0-9]\+"/version = "0.3.20"/' Cargo.lock
$run cargo generate-lockfile
if [ "$TRAVIS_RUST_VERSION" = 1.19.0 ]; then
$run cargo update -p num-integer --precise 0.1.45
$run cargo update -p num-traits --precise 0.2.15
$run cargo update -p libc --precise 0.2.163
fi
$run cargo build --verbose
$run $PWD/ci/test_full.sh
Expand Down
4 changes: 2 additions & 2 deletions src/bigint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ mod bigint_tests;

/// A Sign is a `BigInt`'s composing element.
#[derive(PartialEq, PartialOrd, Eq, Ord, Copy, Clone, Debug, Hash)]
#[cfg_attr(feature = "rustc-serialize", derive(RustcEncodable, RustcDecodable))]
#[cfg_attr(has_derive_rustc_serialize, derive(RustcEncodable, RustcDecodable))]
pub enum Sign {
Minus,
NoSign,
Expand Down Expand Up @@ -104,7 +104,7 @@ impl serde::Deserialize for Sign {

/// A big signed integer type.
#[derive(Clone, Debug, Hash)]
#[cfg_attr(feature = "rustc-serialize", derive(RustcEncodable, RustcDecodable))]
#[cfg_attr(has_derive_rustc_serialize, derive(RustcEncodable, RustcDecodable))]
pub struct BigInt {
sign: Sign,
data: BigUint,
Expand Down
2 changes: 1 addition & 1 deletion src/biguint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ mod biguint_tests;
/// A `BigUint`-typed value `BigUint { data: vec!(a, b, c) }` represents a number
/// `(a + b * big_digit::BASE + c * big_digit::BASE^2)`.
#[derive(Clone, Debug, Hash)]
#[cfg_attr(feature = "rustc-serialize", derive(RustcEncodable, RustcDecodable))]
#[cfg_attr(has_derive_rustc_serialize, derive(RustcEncodable, RustcDecodable))]
pub struct BigUint {
data: Vec<BigDigit>,
}
Expand Down
3 changes: 2 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,10 @@
//!
//! ## Compatibility
//!
//! The `num-bigint` crate is tested for rustc 1.8 and greater.
//! The `num-bigint` crate is tested for rustc 1.19 and greater.

#![doc(html_root_url = "https://docs.rs/num-bigint/0.1")]
#![cfg_attr(has_derive_rustc_serialize, warn(soft_unstable))] // un-deny

#[cfg(any(feature = "rand", test))]
extern crate rand;
Expand Down