milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Improve docs on impl_array_newtype macro 

Trivial cleanup of docs.
This commit is contained in:
Tobin C. Harding 2022-09-20 14:42:14 +10:00
parent 771cdde282
commit a2f08f2bc6
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
internals/src/macros.rs
View File

@ -1,26 +1,26 @@
//! Various macros used by the Rust Bitcoin ecosystem.
//!
/// Implements standard array methods for a given wrapper type
/// Implements standard array methods for a given wrapper type.
#[macro_export]
macro_rules! impl_array_newtype {
($thing:ident, $ty:ty, $len:literal) => {
impl $thing {
/// Converts the object to a raw pointer
/// 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
/// 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
/// Returns the length of the object as an array.
#[inline]
pub fn len(&self) -> usize { $len }
@ -28,15 +28,15 @@ macro_rules! impl_array_newtype {
#[inline]
pub fn is_empty(&self) -> bool { false }
/// Returns the underlying bytes.
/// Returns a reference the underlying bytes.
#[inline]
pub fn as_bytes(&self) -> &[$ty; $len] { &self.0 }
/// Returns the underlying bytes.
/// Returns a clone of the underlying bytes.
#[inline]
pub fn to_bytes(self) -> [$ty; $len] { self.0.clone() }
/// Returns the underlying bytes.
/// Returns the underlying bytes (takes ownership).
#[inline]
pub fn into_bytes(self) -> [$ty; $len] { self.0 }
}