clippy_lints/src/serde_api.rs

   1 use crate::utils::{get_trait_def_id, paths, span_lint};
   2 use rustc::hir::*;
   3 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   4 use rustc::{declare_lint_pass, declare_tool_lint};
   5
   6 declare_clippy_lint! {
   7     /// **What it does:** Checks for mis-uses of the serde API.
   8     ///
   9     /// **Why is this bad?** Serde is very finnicky about how its API should be
  10     /// used, but the type system can't be used to enforce it (yet?).
  11     ///
  12     /// **Known problems:** None.
  13     ///
  14     /// **Example:** Implementing `Visitor::visit_string` but not
  15     /// `Visitor::visit_str`.
  16     pub SERDE_API_MISUSE,
  17     correctness,
  18     "various things that will negatively affect your serde experience"
  19 }
  20
  21 declare_lint_pass!(SerdeAPI => [SERDE_API_MISUSE]);
  22
  23 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for SerdeAPI {
  24     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
  25         if let ItemKind::Impl(_, _, _, _, Some(ref trait_ref), _, ref items) = item.kind {
  26             let did = trait_ref.path.res.def_id();
  27             if let Some(visit_did) = get_trait_def_id(cx, &paths::SERDE_DE_VISITOR) {
  28                 if did == visit_did {
  29                     let mut seen_str = None;
  30                     let mut seen_string = None;
  31                     for item in items {
  32                         match &*item.ident.as_str() {
  33                             "visit_str" => seen_str = Some(item.span),
  34                             "visit_string" => seen_string = Some(item.span),
  35                             _ => {},
  36                         }
  37                     }
  38                     if let Some(span) = seen_string {
  39                         if seen_str.is_none() {
  40                             span_lint(
  41                                 cx,
  42                                 SERDE_API_MISUSE,
  43                                 span,
  44                                 "you should not implement `visit_string` without also implementing `visit_str`",
  45                             );
  46                         }
  47                     }
  48                 }
  49             }
  50         }
  51     }
  52 }