-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add lint on File::read_to_string and File::read_to_end
- Loading branch information
Showing
8 changed files
with
147 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| use crate::utils::{match_type, paths, span_lint_and_help}; | ||
| use if_chain::if_chain; | ||
| use rustc_hir::{Expr, ExprKind, QPath}; | ||
| use rustc_lint::{LateContext, LateLintPass}; | ||
| use rustc_session::{declare_lint_pass, declare_tool_lint}; | ||
|
|
||
| declare_clippy_lint! { | ||
| /// **What it does:** Checks for use of File::read_to_end and File::read_to_string. | ||
| /// | ||
| /// **Why is this bad?** `fs::{read, read_to_string}` provide the same functionality when `buf` is empty with fewer imports and no intermediate values. | ||
| /// | ||
| /// **Known problems:** None. | ||
| /// | ||
| /// **Example:** | ||
| /// | ||
| /// ```rust, ignore | ||
| /// let mut f = File::open("foo.txt")?; | ||
| /// let mut bytes = Vec::new(); | ||
| /// f.read_to_end(&mut bytes)?; | ||
| /// ``` | ||
| /// Can be written more concisely as | ||
| /// ```rust, ignore | ||
| /// let mut bytes = fs::read("foo.txt")?; | ||
| /// ``` | ||
| pub VERBOSE_FILE_READS, | ||
| complexity, | ||
| "use of `File::read_to_end` or `File::read_to_string`" | ||
| } | ||
|
|
||
| declare_lint_pass!(VerboseFileReads => [VERBOSE_FILE_READS]); | ||
|
|
||
| impl<'a, 'tcx> LateLintPass<'a, 'tcx> for VerboseFileReads { | ||
| fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'tcx>) { | ||
| if is_file_read_to_end(cx, expr) { | ||
| span_lint_and_help( | ||
| cx, | ||
| VERBOSE_FILE_READS, | ||
| expr.span, | ||
| "use of File::read_to_end", | ||
| "consider using fs::read instead", | ||
| ); | ||
| } else if is_file_read_to_string(cx, expr) { | ||
| span_lint_and_help( | ||
| cx, | ||
| VERBOSE_FILE_READS, | ||
| expr.span, | ||
| "use of File::read_to_string", | ||
| "consider using fs::read_to_string instead", | ||
| ) | ||
| } else { | ||
| // Don't care | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fn is_file_read_to_end<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'tcx>) -> bool { | ||
| if_chain! { | ||
| if let ExprKind::MethodCall(method_name, _, exprs) = expr.kind; | ||
| if method_name.ident.as_str() == "read_to_end"; | ||
| if let ExprKind::Path(QPath::Resolved(None, _)) = &exprs[0].kind; | ||
| let ty = cx.tables.expr_ty(&exprs[0]); | ||
| if match_type(cx, ty, &paths::FILE); | ||
| then { | ||
| return true | ||
| } | ||
| } | ||
| false | ||
| } | ||
|
|
||
| fn is_file_read_to_string<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'tcx>) -> bool { | ||
| if_chain! { | ||
| if let ExprKind::MethodCall(method_name, _, exprs) = expr.kind; | ||
| if method_name.ident.as_str() == "read_to_string"; | ||
| if let ExprKind::Path(QPath::Resolved(None, _)) = &exprs[0].kind; | ||
| let ty = cx.tables.expr_ty(&exprs[0]); | ||
| if match_type(cx, ty, &paths::FILE); | ||
| then { | ||
| return true | ||
| } | ||
| } | ||
| false | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| #![warn(clippy::verbose_file_reads)] | ||
| use std::env::temp_dir; | ||
| use std::fs::File; | ||
| use std::io::Read; | ||
|
|
||
| struct Struct; | ||
| // To make sure we only warn on File::{read_to_end, read_to_string} calls | ||
| impl Struct { | ||
| pub fn read_to_end(&self) {} | ||
|
|
||
| pub fn read_to_string(&self) {} | ||
| } | ||
|
|
||
| fn main() -> std::io::Result<()> { | ||
| let mut path = temp_dir(); | ||
| path.push("test.txt"); | ||
| let file = File::create(&path)?; | ||
| // Lint shouldn't catch this | ||
| let s = Struct; | ||
| s.read_to_end(); | ||
| s.read_to_string(); | ||
| // Should catch this | ||
| let mut f = File::open(&path)?; | ||
| let mut buffer = Vec::new(); | ||
| f.read_to_end(&mut buffer)?; | ||
| // ...and this | ||
| let mut string_buffer = String::new(); | ||
| f.read_to_string(&mut string_buffer)?; | ||
| Ok(()) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| error: use of File::read_to_end | ||
| --> $DIR/verbose_file_reads.rs:25:5 | ||
| | | ||
| LL | f.read_to_end(&mut buffer)?; | ||
| | ^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| = note: `-D clippy::verbose-file-reads` implied by `-D warnings` | ||
| = help: consider using fs::read instead | ||
|
|
||
| error: use of File::read_to_string | ||
| --> $DIR/verbose_file_reads.rs:28:5 | ||
| | | ||
| LL | f.read_to_string(&mut string_buffer)?; | ||
| | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| = help: consider using fs::read_to_string instead | ||
|
|
||
| error: aborting due to 2 previous errors | ||
|
|