Merge rust-bitcoin/rust-bitcoin#1603: Make max/min_value functions const

7dde3b3b22 Make max/min_value functions const (Tobin C. Harding)

Pull request description:

  The `max_value` and `min_value` functions only exist to be compatible/uniform with Rust 1.41.1 they will never change and they just return a constant value. They can therefore be made const functions.

ACKs for top commit:
  apoelstra:
    ACK 7dde3b3b22
  Kixunil:
    ACK 7dde3b3b22

Tree-SHA512: a998dcc68d409ee01188f1e1e157182b93fae17ad41c6b7440b69dcea367c6f65d7ecbdcdbbcdd6a0a8349e248ff13e06175ca1505df1e01be1935143bbffb3c
This commit is contained in:
Andrew Poelstra 2023-01-31 13:34:50 +00:00
commit d3eab3d5bd
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
5 changed files with 14 additions and 14 deletions

View File

@ -521,10 +521,10 @@ impl Amount {
pub fn to_sat(self) -> u64 { self.0 } pub fn to_sat(self) -> u64 { self.0 }
/// The maximum value of an [Amount]. /// The maximum value of an [Amount].
pub fn max_value() -> Amount { Amount(u64::max_value()) } pub const fn max_value() -> Amount { Amount(u64::max_value()) }
/// The minimum value of an [Amount]. /// The minimum value of an [Amount].
pub fn min_value() -> Amount { Amount(u64::min_value()) } pub const fn min_value() -> Amount { Amount(u64::min_value()) }
/// Convert from a value expressing bitcoins to an [Amount]. /// Convert from a value expressing bitcoins to an [Amount].
pub fn from_btc(btc: f64) -> Result<Amount, ParseAmountError> { pub fn from_btc(btc: f64) -> Result<Amount, ParseAmountError> {
@ -856,10 +856,10 @@ impl SignedAmount {
pub fn to_sat(self) -> i64 { self.0 } pub fn to_sat(self) -> i64 { self.0 }
/// The maximum value of an [SignedAmount]. /// The maximum value of an [SignedAmount].
pub fn max_value() -> SignedAmount { SignedAmount(i64::max_value()) } pub const fn max_value() -> SignedAmount { SignedAmount(i64::max_value()) }
/// The minimum value of an [SignedAmount]. /// The minimum value of an [SignedAmount].
pub fn min_value() -> SignedAmount { SignedAmount(i64::min_value()) } pub const fn min_value() -> SignedAmount { SignedAmount(i64::min_value()) }
/// Convert from a value expressing bitcoins to an [SignedAmount]. /// Convert from a value expressing bitcoins to an [SignedAmount].
pub fn from_btc(btc: f64) -> Result<SignedAmount, ParseAmountError> { pub fn from_btc(btc: f64) -> Result<SignedAmount, ParseAmountError> {

View File

@ -405,12 +405,12 @@ impl Height {
/// The minimum absolute block height (0), the genesis block. /// 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`]. /// This is provided for consistency with Rust 1.41.1, newer code should use [`Height::MIN`].
pub fn min_value() -> Self { Self::MIN } pub const fn min_value() -> Self { Self::MIN }
/// The maximum absolute block height. /// The maximum absolute block height.
/// ///
/// This is provided for consistency with Rust 1.41.1, newer code should use [`Height::MAX`]. /// This is provided for consistency with Rust 1.41.1, newer code should use [`Height::MAX`].
pub fn max_value() -> Self { Self::MAX } pub const fn max_value() -> Self { Self::MAX }
/// Constructs a new block height. /// Constructs a new block height.
/// ///
@ -518,12 +518,12 @@ impl Time {
/// The minimum absolute block time. /// The minimum absolute block time.
/// ///
/// This is provided for consistency with Rust 1.41.1, newer code should use [`Time::MIN`]. /// This is provided for consistency with Rust 1.41.1, newer code should use [`Time::MIN`].
pub fn min_value() -> Self { Self::MIN } pub const fn min_value() -> Self { Self::MIN }
/// The maximum absolute block time. /// The maximum absolute block time.
/// ///
/// This is provided for consistency with Rust 1.41.1, newer code should use [`Time::MAX`]. /// This is provided for consistency with Rust 1.41.1, newer code should use [`Time::MAX`].
pub fn max_value() -> Self { Self::MAX } pub const fn max_value() -> Self { Self::MAX }
/// Constructs a new block time. /// Constructs a new block time.
/// ///

View File

@ -215,12 +215,12 @@ impl Height {
/// The minimum relative block height (0), can be included in any block. /// 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`]. /// This is provided for consistency with Rust 1.41.1, newer code should use [`Height::MIN`].
pub fn min_value() -> Self { Self::MIN } pub const fn min_value() -> Self { Self::MIN }
/// The maximum relative block height. /// The maximum relative block height.
/// ///
/// This is provided for consistency with Rust 1.41.1, newer code should use [`Height::MAX`]. /// This is provided for consistency with Rust 1.41.1, newer code should use [`Height::MAX`].
pub fn max_value() -> Self { Self::MAX } pub const fn max_value() -> Self { Self::MAX }
/// Returns the inner `u16` value. /// Returns the inner `u16` value.
#[inline] #[inline]
@ -263,12 +263,12 @@ impl Time {
/// The minimum relative block time. /// The minimum relative block time.
/// ///
/// This is provided for consistency with Rust 1.41.1, newer code should use [`Time::MIN`]. /// This is provided for consistency with Rust 1.41.1, newer code should use [`Time::MIN`].
pub fn min_value() -> Self { Self::MIN } pub const fn min_value() -> Self { Self::MIN }
/// The maximum relative block time. /// The maximum relative block time.
/// ///
/// This is provided for consistency with Rust 1.41.1, newer code should use [`Time::MAX`]. /// This is provided for consistency with Rust 1.41.1, newer code should use [`Time::MAX`].
pub fn max_value() -> Self { Self::MAX } pub const fn max_value() -> Self { Self::MAX }
/// Create a [`Time`] using time intervals where each interval is equivalent to 512 seconds. /// Create a [`Time`] using time intervals where each interval is equivalent to 512 seconds.
/// ///

View File

@ -321,7 +321,7 @@ impl Sequence {
/// The maximum allowable sequence number. /// The maximum allowable sequence number.
/// ///
/// This is provided for consistency with Rust 1.41.1, newer code should use [`Sequence::MAX`]. /// This is provided for consistency with Rust 1.41.1, newer code should use [`Sequence::MAX`].
pub fn max_value() -> Self { Self::MAX } pub const fn max_value() -> Self { Self::MAX }
/// Returns `true` if the sequence number enables absolute lock-time ([`Transaction::lock_time`]). /// Returns `true` if the sequence number enables absolute lock-time ([`Transaction::lock_time`]).
#[inline] #[inline]

View File

@ -171,7 +171,7 @@ impl Target {
/// The maximum possible target (see [`Target::MAX`]). /// The maximum possible target (see [`Target::MAX`]).
/// ///
/// This is provided for consistency with Rust 1.41.1, newer code should use [`Target::MAX`]. /// This is provided for consistency with Rust 1.41.1, newer code should use [`Target::MAX`].
pub fn max_value() -> Self { Target::MAX } pub const fn max_value() -> Self { Target::MAX }
/// Computes the [`Target`] value from a compact representation. /// Computes the [`Target`] value from a compact representation.
/// ///