From 6cab7beba3873044bb73a0d3855a3ae078ce2aac Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Wed, 3 May 2023 08:26:58 +1000 Subject: [PATCH] Deprecate min/max_value methods Our previous MSRV did not support MIN/MAX associated consts so we had methods min/max_value. Now that our MSRV is Rust 1.48.0 we can use the consts. Deprecate min/max_value methods in favor of MIN/MAX associated conts. --- bitcoin/src/amount.rs | 4 ++++ bitcoin/src/blockdata/locktime/absolute.rs | 4 ++++ bitcoin/src/blockdata/locktime/relative.rs | 4 ++++ bitcoin/src/blockdata/transaction.rs | 1 + bitcoin/src/pow.rs | 1 + 5 files changed, 14 insertions(+) diff --git a/bitcoin/src/amount.rs b/bitcoin/src/amount.rs index 054a5c0d..a5c4e6ef 100644 --- a/bitcoin/src/amount.rs +++ b/bitcoin/src/amount.rs @@ -506,9 +506,11 @@ impl Amount { pub fn to_sat(self) -> u64 { self.0 } /// The maximum value of an [Amount]. + #[deprecated(since = "0.31.0", note = "Use Self::MAX instead")] pub const fn max_value() -> Amount { Amount(u64::max_value()) } /// The minimum value of an [Amount]. + #[deprecated(since = "0.31.0", note = "Use Self::MIN instead")] pub const fn min_value() -> Amount { Amount(u64::min_value()) } /// Convert from a value expressing bitcoins to an [Amount]. @@ -845,9 +847,11 @@ impl SignedAmount { pub fn to_sat(self) -> i64 { self.0 } /// The maximum value of an [SignedAmount]. + #[deprecated(since = "0.31.0", note = "Use Self::MAX instead")] pub const fn max_value() -> SignedAmount { SignedAmount(i64::max_value()) } /// The minimum value of an [SignedAmount]. + #[deprecated(since = "0.31.0", note = "Use Self::MIN instead")] pub const fn min_value() -> SignedAmount { SignedAmount(i64::min_value()) } /// Convert from a value expressing bitcoins to an [SignedAmount]. diff --git a/bitcoin/src/blockdata/locktime/absolute.rs b/bitcoin/src/blockdata/locktime/absolute.rs index 957a50e0..95e31242 100644 --- a/bitcoin/src/blockdata/locktime/absolute.rs +++ b/bitcoin/src/blockdata/locktime/absolute.rs @@ -397,11 +397,13 @@ impl Height { /// The minimum absolute block height (0), the genesis block. /// /// This is provided for consistency with Rust 1.41.1, newer code should use [`Height::MIN`]. + #[deprecated(since = "0.31.0", note = "Use Self::MIN instead")] pub const fn min_value() -> Self { Self::MIN } /// The maximum absolute block height. /// /// This is provided for consistency with Rust 1.41.1, newer code should use [`Height::MAX`]. + #[deprecated(since = "0.31.0", note = "Use Self::MAX instead")] pub const fn max_value() -> Self { Self::MAX } /// Constructs a new block height. @@ -477,11 +479,13 @@ impl Time { /// The minimum absolute block time. /// /// This is provided for consistency with Rust 1.41.1, newer code should use [`Time::MIN`]. + #[deprecated(since = "0.31.0", note = "Use Self::MIN instead")] pub const fn min_value() -> Self { Self::MIN } /// The maximum absolute block time. /// /// This is provided for consistency with Rust 1.41.1, newer code should use [`Time::MAX`]. + #[deprecated(since = "0.31.0", note = "Use Self::MAX instead")] pub const fn max_value() -> Self { Self::MAX } /// Constructs a new block time. diff --git a/bitcoin/src/blockdata/locktime/relative.rs b/bitcoin/src/blockdata/locktime/relative.rs index 4d596acc..d2bdfa97 100644 --- a/bitcoin/src/blockdata/locktime/relative.rs +++ b/bitcoin/src/blockdata/locktime/relative.rs @@ -210,11 +210,13 @@ impl Height { /// The minimum relative block height (0), can be included in any block. /// /// This is provided for consistency with Rust 1.41.1, newer code should use [`Height::MIN`]. + #[deprecated(since = "0.31.0", note = "Use Self::MIN instead")] pub const fn min_value() -> Self { Self::MIN } /// The maximum relative block height. /// /// This is provided for consistency with Rust 1.41.1, newer code should use [`Height::MAX`]. + #[deprecated(since = "0.31.0", note = "Use Self::MAX instead")] pub const fn max_value() -> Self { Self::MAX } /// Returns the inner `u16` value. @@ -254,11 +256,13 @@ impl Time { /// The minimum relative block time. /// /// This is provided for consistency with Rust 1.41.1, newer code should use [`Time::MIN`]. + #[deprecated(since = "0.31.0", note = "Use Self::MIN instead")] pub const fn min_value() -> Self { Self::MIN } /// The maximum relative block time. /// /// This is provided for consistency with Rust 1.41.1, newer code should use [`Time::MAX`]. + #[deprecated(since = "0.31.0", note = "Use Self::MAX instead")] pub const fn max_value() -> Self { Self::MAX } /// Create a [`Time`] using time intervals where each interval is equivalent to 512 seconds. diff --git a/bitcoin/src/blockdata/transaction.rs b/bitcoin/src/blockdata/transaction.rs index d3da2552..1b6dd415 100644 --- a/bitcoin/src/blockdata/transaction.rs +++ b/bitcoin/src/blockdata/transaction.rs @@ -305,6 +305,7 @@ impl Sequence { /// The maximum allowable sequence number. /// /// This is provided for consistency with Rust 1.41.1, newer code should use [`Sequence::MAX`]. + #[deprecated(since = "0.31.0", note = "Use Self::MAX instead")] pub const fn max_value() -> Self { Self::MAX } /// Returns `true` if the sequence number enables absolute lock-time ([`Transaction::lock_time`]). diff --git a/bitcoin/src/pow.rs b/bitcoin/src/pow.rs index 82d21718..42642d19 100644 --- a/bitcoin/src/pow.rs +++ b/bitcoin/src/pow.rs @@ -133,6 +133,7 @@ impl Target { /// The maximum possible target (see [`Target::MAX`]). /// /// This is provided for consistency with Rust 1.41.1, newer code should use [`Target::MAX`]. + #[deprecated(since = "0.31.0", note = "Use Self::MAX instead")] pub const fn max_value() -> Self { Target::MAX } /// Computes the [`Target`] value from a compact representation.