GRIN/grin-node
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore/docs: eliminate warnings (#2583)

Browse Source 
* chore: replace trim_right with $ sed -i'' 's/trim_right/trim_end/' **/*.rs

* docs: individually document macros to avoid warning, add TODO to make to_edge hygenic

* docs: document impl_array_newtype macros, refactor: move all impl_array_newtype macro traits into impl_array_netype_index
This commit is contained in:
Jeremy Rubin
2019-02-15 15:32:37 -08:00
committed by Ignotus Peverell
parent ac6ed71abd
commit dc6542d82b
3 changed files with 20 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
util/src/macros.rs
+14 -11
View File
@@ -28,6 +28,7 @@
//! Macros to support Rust BIP-32 code (though could conceivably be used for other things)
/// gives a newtype array wrapper standard array traits
#[macro_export]
macro_rules! impl_array_newtype {
($thing:ident, $ty:ty, $len:expr) => {
@@ -86,16 +87,6 @@ macro_rules! impl_array_newtype {
}
}
impl ::std::ops::Index<usize> for $thing {
type Output = $ty;
#[inline]
fn index(&self, index: usize) -> &$ty {
let &$thing(ref dat) = self;
&dat[index]
}
}
impl_index_newtype!($thing, $ty);
impl PartialEq for $thing {
@@ -164,6 +155,7 @@ macro_rules! impl_array_newtype {
};
}
/// gives a newtype array wrapper serialization and deserialization methods
#[macro_export]
macro_rules! impl_array_newtype_encodable {
($thing:ident, $ty:ty, $len:expr) => {
@@ -193,7 +185,7 @@ macro_rules! impl_array_newtype_encodable {
*item = match seq.next_element()? {
Some(c) => c,
None => {
return Err($crate::serde::de::Error::custom("end of stream"))
return Err($crate::serde::de::Error::custom("end of stream"));
}
};
}
@@ -218,6 +210,7 @@ macro_rules! impl_array_newtype_encodable {
};
}
/// gives a newtype array wrapper the Debug trait
#[macro_export]
macro_rules! impl_array_newtype_show {
($thing:ident) => {
@@ -229,9 +222,19 @@ macro_rules! impl_array_newtype_show {
};
}
/// gives a newtype array wrapper Index traits
#[macro_export]
macro_rules! impl_index_newtype {
($thing:ident, $ty:ty) => {
impl ::std::ops::Index<usize> for $thing {
type Output = $ty;
#[inline]
fn index(&self, index: usize) -> &$ty {
let &$thing(ref dat) = self;
&dat[index]
}
}
impl ::std::ops::Index<::std::ops::Range<usize>> for $thing {
type Output = [$ty];