aitzol/Plume
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix warnings about unused doc comments

Browse Source 
we do this by making the macro parse and generate doc comments
This commit is contained in:
Mina Galić 2020-05-25 15:44:32 +02:00
parent 492bbb1ba6
commit 7490567a21
No known key found for this signature in database
GPG Key ID: ACFEFF7F6A123A86
1 changed files with 59 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
plume-models/src/lists.rs
View File

@ -58,7 +58,11 @@ struct NewList<'a> {
} }
macro_rules! func { macro_rules! func {
(@elem User $id:expr, $value:expr) => { (
$(#[$outer:meta])*
@elem User $id:expr, $value:expr
) => {
$(#[$outer])*
NewListElem { NewListElem {
list_id: $id, list_id: $id,
user_id: Some(*$value), user_id: Some(*$value),
@ -66,7 +70,11 @@ macro_rules! func {
word: None, word: None,
} }
}; };
(@elem Blog $id:expr, $value:expr) => { (
$(#[$outer:meta])*
@elem Blog $id:expr, $value:expr
) => {
$(#[$outer])*
NewListElem { NewListElem {
list_id: $id, list_id: $id,
user_id: None, user_id: None,
@ -74,7 +82,11 @@ macro_rules! func {
word: None, word: None,
} }
}; };
(@elem Word $id:expr, $value:expr) => { (
$(#[$outer:meta])*
@elem Word $id:expr, $value:expr
) => {
$(#[$outer])*
NewListElem { NewListElem {
list_id: $id, list_id: $id,
user_id: None, user_id: None,
@ -82,7 +94,11 @@ macro_rules! func {
word: Some($value), word: Some($value),
} }
}; };
(@elem Prefix $id:expr, $value:expr) => { (
$(#[$outer:meta])*
@elem Prefix $id:expr, $value:expr
) => {
$(#[$outer])*
NewListElem { NewListElem {
list_id: $id, list_id: $id,
user_id: None, user_id: None,
@ -99,7 +115,11 @@ macro_rules! func {
(@out_type Word) => { String }; (@out_type Word) => { String };
(@out_type Prefix) => { String }; (@out_type Prefix) => { String };
(add: $fn:ident, $kind:ident) => { (
$(#[$outer:meta])*
add: $fn:ident, $kind:ident
) => {
$(#[$outer])*
pub fn $fn(&self, conn: &Connection, vals: &[func!(@in_type $kind)]) -> Result<()> { pub fn $fn(&self, conn: &Connection, vals: &[func!(@in_type $kind)]) -> Result<()> {
if self.kind() != ListType::$kind { if self.kind() != ListType::$kind {
return Err(Error::InvalidValue); return Err(Error::InvalidValue);
@ -116,7 +136,11 @@ macro_rules! func {
} }
}; };
(list: $fn:ident, $kind:ident, $table:ident) => { (
$(#[$outer:meta])*
list: $fn:ident, $kind:ident, $table:ident
) => {
$(#[$outer])*
pub fn $fn(&self, conn: &Connection) -> Result<Vec<func!(@out_type $kind)>> { pub fn $fn(&self, conn: &Connection) -> Result<Vec<func!(@out_type $kind)>> {
if self.kind() != ListType::$kind { if self.kind() != ListType::$kind {
return Err(Error::InvalidValue); return Err(Error::InvalidValue);
@ -132,7 +156,11 @@ macro_rules! func {
(set: $fn:ident, $kind:ident, $add:ident) => { (
$(#[$outer:meta])*
set: $fn:ident, $kind:ident, $add:ident
) => {
$(#[$outer])*
pub fn $fn(&self, conn: &Connection, val: &[func!(@in_type $kind)]) -> Result<()> { pub fn $fn(&self, conn: &Connection, val: &[func!(@in_type $kind)]) -> Result<()> {
if self.kind() != ListType::$kind { if self.kind() != ListType::$kind {
return Err(Error::InvalidValue); return Err(Error::InvalidValue);
@ -246,23 +274,35 @@ impl List {
private::ListElem::prefix_in_list(conn, self, word) private::ListElem::prefix_in_list(conn, self, word)
} }
/// Insert new users in a list func! {
func! {add: add_users, User} /// Insert new users in a list
add: add_users, User
}
/// Insert new blogs in a list func! {
func! {add: add_blogs, Blog} /// Insert new blogs in a list
add: add_blogs, Blog
}
/// Insert new words in a list func! {
func! {add: add_words, Word} /// Insert new words in a list
add: add_words, Word
}
/// Insert new prefixes in a list func! {
func! {add: add_prefixes, Prefix} /// Insert new prefixes in a list
add: add_prefixes, Prefix
}
/// Get all users in the list func! {
func! {list: list_users, User, users} /// Get all users in the list
list: list_users, User, users
}
/// Get all blogs in the list func! {
func! {list: list_blogs, Blog, blogs} /// Get all blogs in the list
list: list_blogs, Blog, blogs
}
/// Get all words in the list /// Get all words in the list
pub fn list_words(&self, conn: &Connection) -> Result<Vec<String>> { pub fn list_words(&self, conn: &Connection) -> Result<Vec<String>> {