rust/clippy_lints/src/serde_api.rs

58 lines
2.1 KiB
Rust
Raw Normal View History

2018-05-30 03:15:50 -05:00
use crate::utils::{get_trait_def_id, paths, span_lint};
use rustc_hir::{Impl, Item, ItemKind};
2020-01-12 00:08:41 -06:00
use rustc_lint::{LateContext, LateLintPass};
2020-01-11 05:37:08 -06:00
use rustc_session::{declare_lint_pass, declare_tool_lint};
2018-03-28 08:24:26 -05:00
declare_clippy_lint! {
/// **What it does:** Checks for mis-uses of the serde API.
///
/// **Why is this bad?** Serde is very finnicky about how its API should be
/// used, but the type system can't be used to enforce it (yet?).
///
/// **Known problems:** None.
///
/// **Example:** Implementing `Visitor::visit_string` but not
/// `Visitor::visit_str`.
pub SERDE_API_MISUSE,
2018-03-28 08:24:26 -05:00
correctness,
"various things that will negatively affect your serde experience"
}
2019-04-08 15:43:55 -05:00
declare_lint_pass!(SerdeAPI => [SERDE_API_MISUSE]);
impl<'tcx> LateLintPass<'tcx> for SerdeAPI {
fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx Item<'_>) {
if let ItemKind::Impl(Impl {
2020-01-17 23:14:36 -06:00
of_trait: Some(ref trait_ref),
items,
..
}) = item.kind
2020-01-17 23:14:36 -06:00
{
let did = trait_ref.path.res.def_id();
2019-05-17 16:53:54 -05:00
if let Some(visit_did) = get_trait_def_id(cx, &paths::SERDE_DE_VISITOR) {
if did == visit_did {
let mut seen_str = None;
let mut seen_string = None;
for item in items {
2018-06-28 08:46:58 -05:00
match &*item.ident.as_str() {
"visit_str" => seen_str = Some(item.span),
"visit_string" => seen_string = Some(item.span),
_ => {},
}
}
if let Some(span) = seen_string {
if seen_str.is_none() {
2017-08-09 02:30:56 -05:00
span_lint(
cx,
SERDE_API_MISUSE,
span,
"you should not implement `visit_string` without also implementing `visit_str`",
);
}
}
}
}
}
}
}