Move impl_array_newtype to internal_macros
The current feature gating is wrong, this bug is unreleased because it was introduced #2585. The `impl_array_newtype` macro is only used in the `bitcoin` crate, it does not need to be in `internals`. Also, other crates have an `alloc` feature which `bitcoin` does not have so if we ever need it in other places we'll need a duplicate with the correct feature gating anyways. Move the macro to `bitcoin::internal_macros` and remove the incorrect `alloc` feature gating.
This commit is contained in:
Tobin C. Harding
parent
3c16ed05c9
commit
a6b7ab32a8
|
|
@ -9,11 +9,13 @@ use core::{convert, fmt, mem};
|
|||
use std::error;
|
||||
|
||||
use hashes::{sha256, siphash24};
|
||||
use internals::{impl_array_newtype, ToU64 as _};
|
||||
use internals::ToU64 as _;
|
||||
use io::{BufRead, Write};
|
||||
|
||||
use crate::consensus::encode::{self, Decodable, Encodable, ReadExt, WriteExt};
|
||||
use crate::internal_macros::{impl_array_newtype_stringify, impl_consensus_encoding};
|
||||
use crate::internal_macros::{
|
||||
impl_array_newtype, impl_array_newtype_stringify, impl_consensus_encoding,
|
||||
};
|
||||
use crate::prelude::Vec;
|
||||
use crate::transaction::TxIdentifier;
|
||||
use crate::{block, consensus, Block, BlockHash, Transaction};
|
||||
|
|
|
|||
|
|
@ -10,11 +10,11 @@ use core::str::FromStr;
|
|||
use core::{fmt, slice};
|
||||
|
||||
use hashes::{hash160, hash_newtype, sha512, GeneralHash, HashEngine, Hmac, HmacEngine};
|
||||
use internals::{impl_array_newtype, write_err};
|
||||
use internals::write_err;
|
||||
use secp256k1::{Secp256k1, XOnlyPublicKey};
|
||||
|
||||
use crate::crypto::key::{CompressedPublicKey, Keypair, PrivateKey};
|
||||
use crate::internal_macros::impl_array_newtype_stringify;
|
||||
use crate::internal_macros::{impl_array_newtype, impl_array_newtype_stringify};
|
||||
use crate::network::NetworkKind;
|
||||
use crate::prelude::{String, Vec};
|
||||
|
||||
|
|
|
|||
|
|
@ -7,10 +7,9 @@
|
|||
//! single transaction.
|
||||
|
||||
use hashes::sha256d;
|
||||
use internals::impl_array_newtype;
|
||||
|
||||
use crate::block::{self, Block};
|
||||
use crate::internal_macros::impl_array_newtype_stringify;
|
||||
use crate::internal_macros::{impl_array_newtype, impl_array_newtype_stringify};
|
||||
use crate::locktime::absolute;
|
||||
use crate::network::{Network, Params};
|
||||
use crate::opcodes::all::*;
|
||||
|
|
|
|||
|
|
@ -276,3 +276,121 @@ macro_rules! define_extension_trait {
|
|||
};
|
||||
}
|
||||
pub(crate) use define_extension_trait;
|
||||
|
||||
/// Implements standard array methods for a given wrapper type.
|
||||
macro_rules! impl_array_newtype {
|
||||
($thing:ident, $ty:ty, $len:literal) => {
|
||||
impl $thing {
|
||||
/// Creates `Self` by wrapping `bytes`.
|
||||
#[inline]
|
||||
pub fn from_byte_array(bytes: [u8; $len]) -> Self { Self(bytes) }
|
||||
|
||||
/// Returns a reference the underlying byte array.
|
||||
#[inline]
|
||||
pub fn as_byte_array(&self) -> &[u8; $len] { &self.0 }
|
||||
|
||||
/// Returns the underlying byte array.
|
||||
#[inline]
|
||||
pub fn to_byte_array(self) -> [u8; $len] {
|
||||
// We rely on `Copy` being implemented for $thing so conversion
|
||||
// methods use the correct Rust naming conventions.
|
||||
fn check_copy<T: Copy>() {}
|
||||
check_copy::<$thing>();
|
||||
|
||||
self.0
|
||||
}
|
||||
|
||||
/// Returns a slice of the underlying bytes.
|
||||
#[inline]
|
||||
pub fn as_bytes(&self) -> &[u8] { &self.0 }
|
||||
|
||||
/// Copies the underlying bytes into a new `Vec`.
|
||||
#[inline]
|
||||
pub fn to_bytes(&self) -> alloc::vec::Vec<u8> { self.0.to_vec() }
|
||||
|
||||
/// Converts the object to a raw pointer.
|
||||
#[inline]
|
||||
pub fn as_ptr(&self) -> *const $ty {
|
||||
let &$thing(ref dat) = self;
|
||||
dat.as_ptr()
|
||||
}
|
||||
|
||||
/// Converts the object to a mutable raw pointer.
|
||||
#[inline]
|
||||
pub fn as_mut_ptr(&mut self) -> *mut $ty {
|
||||
let &mut $thing(ref mut dat) = self;
|
||||
dat.as_mut_ptr()
|
||||
}
|
||||
|
||||
/// Returns the length of the object as an array.
|
||||
#[inline]
|
||||
pub fn len(&self) -> usize { $len }
|
||||
|
||||
/// Returns whether the object, as an array, is empty. Always false.
|
||||
#[inline]
|
||||
pub fn is_empty(&self) -> bool { false }
|
||||
}
|
||||
|
||||
impl<'a> core::convert::From<[$ty; $len]> for $thing {
|
||||
fn from(data: [$ty; $len]) -> Self { $thing(data) }
|
||||
}
|
||||
|
||||
impl<'a> core::convert::From<&'a [$ty; $len]> for $thing {
|
||||
fn from(data: &'a [$ty; $len]) -> Self { $thing(*data) }
|
||||
}
|
||||
|
||||
impl<'a> core::convert::TryFrom<&'a [$ty]> for $thing {
|
||||
type Error = core::array::TryFromSliceError;
|
||||
|
||||
fn try_from(data: &'a [$ty]) -> core::result::Result<Self, Self::Error> {
|
||||
use core::convert::TryInto;
|
||||
|
||||
Ok($thing(data.try_into()?))
|
||||
}
|
||||
}
|
||||
|
||||
impl AsRef<[$ty; $len]> for $thing {
|
||||
fn as_ref(&self) -> &[$ty; $len] { &self.0 }
|
||||
}
|
||||
|
||||
impl AsMut<[$ty; $len]> for $thing {
|
||||
fn as_mut(&mut self) -> &mut [$ty; $len] { &mut self.0 }
|
||||
}
|
||||
|
||||
impl AsRef<[$ty]> for $thing {
|
||||
fn as_ref(&self) -> &[$ty] { &self.0 }
|
||||
}
|
||||
|
||||
impl AsMut<[$ty]> for $thing {
|
||||
fn as_mut(&mut self) -> &mut [$ty] { &mut self.0 }
|
||||
}
|
||||
|
||||
impl core::borrow::Borrow<[$ty; $len]> for $thing {
|
||||
fn borrow(&self) -> &[$ty; $len] { &self.0 }
|
||||
}
|
||||
|
||||
impl core::borrow::BorrowMut<[$ty; $len]> for $thing {
|
||||
fn borrow_mut(&mut self) -> &mut [$ty; $len] { &mut self.0 }
|
||||
}
|
||||
|
||||
// The following two are valid because `[T; N]: Borrow<[T]>`
|
||||
impl core::borrow::Borrow<[$ty]> for $thing {
|
||||
fn borrow(&self) -> &[$ty] { &self.0 }
|
||||
}
|
||||
|
||||
impl core::borrow::BorrowMut<[$ty]> for $thing {
|
||||
fn borrow_mut(&mut self) -> &mut [$ty] { &mut self.0 }
|
||||
}
|
||||
|
||||
impl<I> core::ops::Index<I> for $thing
|
||||
where
|
||||
[$ty]: core::ops::Index<I>,
|
||||
{
|
||||
type Output = <[$ty] as core::ops::Index<I>>::Output;
|
||||
|
||||
#[inline]
|
||||
fn index(&self, index: I) -> &Self::Output { &self.0[index] }
|
||||
}
|
||||
};
|
||||
}
|
||||
pub(crate) use impl_array_newtype;
|
||||
|
|
|
|||
|
|
@ -2,125 +2,6 @@
|
|||
|
||||
//! Various macros used by the Rust Bitcoin ecosystem.
|
||||
|
||||
/// Implements standard array methods for a given wrapper type.
|
||||
#[macro_export]
|
||||
macro_rules! impl_array_newtype {
|
||||
($thing:ident, $ty:ty, $len:literal) => {
|
||||
impl $thing {
|
||||
/// Creates `Self` by wrapping `bytes`.
|
||||
#[inline]
|
||||
pub fn from_byte_array(bytes: [u8; $len]) -> Self { Self(bytes) }
|
||||
|
||||
/// Returns a reference the underlying byte array.
|
||||
#[inline]
|
||||
pub fn as_byte_array(&self) -> &[u8; $len] { &self.0 }
|
||||
|
||||
/// Returns the underlying byte array.
|
||||
#[inline]
|
||||
pub fn to_byte_array(self) -> [u8; $len] {
|
||||
// We rely on `Copy` being implemented for $thing so conversion
|
||||
// methods use the correct Rust naming conventions.
|
||||
fn check_copy<T: Copy>() {}
|
||||
check_copy::<$thing>();
|
||||
|
||||
self.0
|
||||
}
|
||||
|
||||
/// Returns a slice of the underlying bytes.
|
||||
#[inline]
|
||||
pub fn as_bytes(&self) -> &[u8] { &self.0 }
|
||||
|
||||
/// Copies the underlying bytes into a new `Vec`.
|
||||
#[cfg(feature = "alloc")]
|
||||
#[inline]
|
||||
pub fn to_bytes(&self) -> alloc::vec::Vec<u8> { self.0.to_vec() }
|
||||
|
||||
/// Converts the object to a raw pointer.
|
||||
#[inline]
|
||||
pub fn as_ptr(&self) -> *const $ty {
|
||||
let &$thing(ref dat) = self;
|
||||
dat.as_ptr()
|
||||
}
|
||||
|
||||
/// Converts the object to a mutable raw pointer.
|
||||
#[inline]
|
||||
pub fn as_mut_ptr(&mut self) -> *mut $ty {
|
||||
let &mut $thing(ref mut dat) = self;
|
||||
dat.as_mut_ptr()
|
||||
}
|
||||
|
||||
/// Returns the length of the object as an array.
|
||||
#[inline]
|
||||
pub fn len(&self) -> usize { $len }
|
||||
|
||||
/// Returns whether the object, as an array, is empty. Always false.
|
||||
#[inline]
|
||||
pub fn is_empty(&self) -> bool { false }
|
||||
}
|
||||
|
||||
impl<'a> core::convert::From<[$ty; $len]> for $thing {
|
||||
fn from(data: [$ty; $len]) -> Self { $thing(data) }
|
||||
}
|
||||
|
||||
impl<'a> core::convert::From<&'a [$ty; $len]> for $thing {
|
||||
fn from(data: &'a [$ty; $len]) -> Self { $thing(*data) }
|
||||
}
|
||||
|
||||
impl<'a> core::convert::TryFrom<&'a [$ty]> for $thing {
|
||||
type Error = core::array::TryFromSliceError;
|
||||
|
||||
fn try_from(data: &'a [$ty]) -> core::result::Result<Self, Self::Error> {
|
||||
use core::convert::TryInto;
|
||||
|
||||
Ok($thing(data.try_into()?))
|
||||
}
|
||||
}
|
||||
|
||||
impl AsRef<[$ty; $len]> for $thing {
|
||||
fn as_ref(&self) -> &[$ty; $len] { &self.0 }
|
||||
}
|
||||
|
||||
impl AsMut<[$ty; $len]> for $thing {
|
||||
fn as_mut(&mut self) -> &mut [$ty; $len] { &mut self.0 }
|
||||
}
|
||||
|
||||
impl AsRef<[$ty]> for $thing {
|
||||
fn as_ref(&self) -> &[$ty] { &self.0 }
|
||||
}
|
||||
|
||||
impl AsMut<[$ty]> for $thing {
|
||||
fn as_mut(&mut self) -> &mut [$ty] { &mut self.0 }
|
||||
}
|
||||
|
||||
impl core::borrow::Borrow<[$ty; $len]> for $thing {
|
||||
fn borrow(&self) -> &[$ty; $len] { &self.0 }
|
||||
}
|
||||
|
||||
impl core::borrow::BorrowMut<[$ty; $len]> for $thing {
|
||||
fn borrow_mut(&mut self) -> &mut [$ty; $len] { &mut self.0 }
|
||||
}
|
||||
|
||||
// The following two are valid because `[T; N]: Borrow<[T]>`
|
||||
impl core::borrow::Borrow<[$ty]> for $thing {
|
||||
fn borrow(&self) -> &[$ty] { &self.0 }
|
||||
}
|
||||
|
||||
impl core::borrow::BorrowMut<[$ty]> for $thing {
|
||||
fn borrow_mut(&mut self) -> &mut [$ty] { &mut self.0 }
|
||||
}
|
||||
|
||||
impl<I> core::ops::Index<I> for $thing
|
||||
where
|
||||
[$ty]: core::ops::Index<I>,
|
||||
{
|
||||
type Output = <[$ty] as core::ops::Index<I>>::Output;
|
||||
|
||||
#[inline]
|
||||
fn index(&self, index: I) -> &Self::Output { &self.0[index] }
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
/// Implements `Debug` by calling through to `Display`.
|
||||
#[macro_export]
|
||||
macro_rules! debug_from_display {
|
||||
|
|
|
|||
Loading…
Reference in New Issue