Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-01-20 19:11:08 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

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
Show stats Download patch file Download diff file Expand all files Collapse all files

2
api/src/web.rs
View file

@ -142,7 +142,7 @@ impl From<Request<Body>> for QueryParams {
#[macro_export] #[macro_export]
macro_rules! right_path_element( macro_rules! right_path_element(
($req: expr) =>( ($req: expr) =>(
match $req.uri().path().trim_right_matches('/').rsplit('/').next() { match $req.uri().path().trim_end_matches('/').rsplit('/').next() {
None => return response(StatusCode::BAD_REQUEST, "invalid url"), None => return response(StatusCode::BAD_REQUEST, "invalid url"),
Some(el) => el, Some(el) => el,
}; };

6
core/src/pow/common.rs
View file

@ -102,7 +102,7 @@ pub fn create_siphash_keys(header: &[u8]) -> Result<[u64; 4], Error> {
]) ])
} }
/// Macros to clean up integer unwrapping /// Macro to clean up u64 unwrapping
#[macro_export] #[macro_export]
macro_rules! to_u64 { macro_rules! to_u64 {
($n:expr) => { ($n:expr) => {
@ -110,6 +110,7 @@ macro_rules! to_u64 {
}; };
} }
/// Macro to clean up u64 unwrapping as u32
#[macro_export] #[macro_export]
macro_rules! to_u32 { macro_rules! to_u32 {
($n:expr) => { ($n:expr) => {
@ -117,6 +118,7 @@ macro_rules! to_u32 {
}; };
} }
/// Macro to clean up u64 unwrapping as usize
#[macro_export] #[macro_export]
macro_rules! to_usize { macro_rules! to_usize {
($n:expr) => { ($n:expr) => {
@ -124,6 +126,8 @@ macro_rules! to_usize {
}; };
} }
/// Macro to clean up casting to edge type
/// TODO: this macro uses unhygenic data T
#[macro_export] #[macro_export]
macro_rules! to_edge { macro_rules! to_edge {
($n:expr) => { ($n:expr) => {

25
util/src/macros.rs
View file

@ -28,6 +28,7 @@
//! Macros to support Rust BIP-32 code (though could conceivably be used for other things) //! 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_export]
macro_rules! impl_array_newtype { macro_rules! impl_array_newtype {
($thing:ident, $ty:ty, $len:expr) => { ($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_index_newtype!($thing, $ty);
impl PartialEq for $thing { 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_export]
macro_rules! impl_array_newtype_encodable { macro_rules! impl_array_newtype_encodable {
($thing:ident, $ty:ty, $len:expr) => { ($thing:ident, $ty:ty, $len:expr) => {
@ -193,7 +185,7 @@ macro_rules! impl_array_newtype_encodable {
*item = match seq.next_element()? { *item = match seq.next_element()? {
Some(c) => c, Some(c) => c,
None => { 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_export]
macro_rules! impl_array_newtype_show { macro_rules! impl_array_newtype_show {
($thing:ident) => { ($thing:ident) => {
@ -229,9 +222,19 @@ macro_rules! impl_array_newtype_show {
}; };
} }
/// gives a newtype array wrapper Index traits
#[macro_export] #[macro_export]
macro_rules! impl_index_newtype { macro_rules! impl_index_newtype {
($thing:ident, $ty:ty) => { ($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 { impl ::std::ops::Index<::std::ops::Range<usize>> for $thing {
type Output = [$ty]; type Output = [$ty];