Merge rust-bitcoin/rust-bitcoin#3867: units: Hide the remaining public macros

9396041524 api: Run just check-api (Tobin C. Harding)
ffd8702cb3 units: Hide the remaining public macros (Tobin C. Harding)

Pull request description:

  We do not want to commit to any public macros in `units`. Recently we (I at least) learned that adding `doc(hidden)` signals to users that the macro is unstable and should not be relied upon.

  Hide the remaining two macros so we can release 1.0 and not worry about later breaking them.

  With this applied there are no exported macros that are not hidden. Verify using `git grep -A 1 macro_export`.

ACKs for top commit:
  apoelstra:
    ACK 9396041524e291203d5c86665639872f9a6246b5; successfully ran local tests; Yeah, let's do it

Tree-SHA512: a3a59897a2fe16276ab2d364ff247f48772a63a25f91eabc17023a37b9fab3860639dc1e09193c938dd73711ba20c95b8d0ad9db9493d269ee9328b2132d61cb
This commit is contained in:
merge-script 2025-01-08 00:57:01 +00:00
commit 1f36625317
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
4 changed files with 2 additions and 6 deletions

View File

@ -1220,8 +1220,6 @@ pub fn u32::from(height: bitcoin_units::block::BlockInterval) -> Self
pub fn u64::from(value: bitcoin_units::fee_rate::FeeRate) -> Self
pub fn u64::from(value: bitcoin_units::weight::Weight) -> Self
pub fn u64::mul(self, rhs: bitcoin_units::weight::Weight) -> Self::Output
pub macro bitcoin_units::impl_parse_str!
pub macro bitcoin_units::impl_parse_str_from_int_infallible!
pub mod bitcoin_units
pub mod bitcoin_units::amount
pub mod bitcoin_units::amount::serde

View File

@ -1064,8 +1064,6 @@ pub fn u32::from(height: bitcoin_units::block::BlockInterval) -> Self
pub fn u64::from(value: bitcoin_units::fee_rate::FeeRate) -> Self
pub fn u64::from(value: bitcoin_units::weight::Weight) -> Self
pub fn u64::mul(self, rhs: bitcoin_units::weight::Weight) -> Self::Output
pub macro bitcoin_units::impl_parse_str!
pub macro bitcoin_units::impl_parse_str_from_int_infallible!
pub mod bitcoin_units
pub mod bitcoin_units::amount
pub mod bitcoin_units::block

View File

@ -1018,8 +1018,6 @@ pub fn u32::from(height: bitcoin_units::block::BlockInterval) -> Self
pub fn u64::from(value: bitcoin_units::fee_rate::FeeRate) -> Self
pub fn u64::from(value: bitcoin_units::weight::Weight) -> Self
pub fn u64::mul(self, rhs: bitcoin_units::weight::Weight) -> Self::Output
pub macro bitcoin_units::impl_parse_str!
pub macro bitcoin_units::impl_parse_str_from_int_infallible!
pub mod bitcoin_units
pub mod bitcoin_units::amount
pub mod bitcoin_units::block

View File

@ -117,6 +117,7 @@ pub fn int<T: Integer, S: AsRef<str> + Into<InputString>>(s: S) -> Result<T, Par
///
/// If parsing the string fails then a `units::parse::ParseIntError` is returned.
#[macro_export]
#[doc(hidden)] // This is an 'internal' macro that should not be used outside of the `rust-bitcoin` crate.
macro_rules! impl_parse_str_from_int_infallible {
($to:ident, $inner:ident, $fn:ident) => {
$crate::impl_tryfrom_str_from_int_infallible!(&str, $to, $inner, $fn);
@ -174,6 +175,7 @@ macro_rules! impl_tryfrom_str_from_int_infallible {
///
/// All functions use the error returned by `$inner_fn`.
#[macro_export]
#[doc(hidden)] // This is an 'internal' macro that should not be used outside of the `rust-bitcoin` crate.
macro_rules! impl_parse_str {
($to:ty, $err:ty, $inner_fn:expr) => {
$crate::impl_tryfrom_str!(&str, $to, $err, $inner_fn);