mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Formatting

Browse Source
This commit is contained in:
Philipp Krones 2023-08-16 14:44:26 +02:00
parent 9e4a2d7fca
commit e8d79b8645
No known key found for this signature in database
GPG Key ID: 1CA0DF2AF59D68A5
1 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
book/src/development/method_checking.md
View File

@ -37,26 +37,24 @@ impl<'tcx> LateLintPass<'tcx> for OurFancyMethodLint {
``` ```
Take a closer look at the `ExprKind` enum variant [`MethodCall`] for more Take a closer look at the `ExprKind` enum variant [`MethodCall`] for more
information on the pattern matching. information on the pattern matching. As mentioned in [Define
As mentioned in [Define Lints](define_lints.md#lint-types), Lints](define_lints.md#lint-types), the `methods` lint type is full of pattern
the `methods` lint type is full of pattern matching with `Methodcall` matching with `MethodCall` in case the reader wishes to explore more.
in case the reader wishes to explore more.
Additionally, we use the [`clippy_utils::sym!`][sym] macro to conveniently convert Additionally, we use the [`clippy_utils::sym!`][sym] macro to conveniently
an input `our_fancy_method` into a `Symbol` and compare that symbol to the [`ident`][Ident]'s name in the [`PathSegment`] convert an input `our_fancy_method` into a `Symbol` and compare that symbol to
in the [`MethodCall`]. the [`Ident`]'s name in the [`PathSegment`] in the [`MethodCall`].
## Checking if a `impl` block implements a method ## Checking if a `impl` block implements a method
While sometimes we want to check whether a method is being called or not, While sometimes we want to check whether a method is being called or not, other
other times we want to know if our `Ty` defines a method. times we want to know if our `Ty` defines a method.
To check if our `impl` block defines a method `our_fancy_method`, To check if our `impl` block defines a method `our_fancy_method`, we will
we will utilize the [`check_impl_item`] method that is available utilize the [`check_impl_item`] method that is available in our beloved
in our beloved [`LateLintPass`] (for more information, refer to the [`LateLintPass`] (for more information, refer to the ["Lint
["Lint Passes"](lint_passes.md) chapter in Clippy book). Passes"](lint_passes.md) chapter in the Clippy book). This method provides us
This method provides us with an [`ImplItem`] struct, which represents with an [`ImplItem`] struct, which represents anything within an `impl` block.
anything within an `impl` block.
Let us take a look at how we might check for the implementation of Let us take a look at how we might check for the implementation of
`our_fancy_method` on a type: `our_fancy_method` on a type:
@ -67,6 +65,7 @@ use clippy_utils::return_ty;
use rustc_hir::{ImplItem, ImplItemKind}; use rustc_hir::{ImplItem, ImplItemKind};
use rustc_lint::{LateContext, LateLintPass}; use rustc_lint::{LateContext, LateLintPass};
use rustc_span::symbol::sym; use rustc_span::symbol::sym;
impl<'tcx> LateLintPass<'tcx> for MyTypeImpl { impl<'tcx> LateLintPass<'tcx> for MyTypeImpl {
fn check_impl_item(&mut self, cx: &LateContext<'tcx>, impl_item: &'tcx ImplItem<'_>) { fn check_impl_item(&mut self, cx: &LateContext<'tcx>, impl_item: &'tcx ImplItem<'_>) {
// Check if item is a method/function // Check if item is a method/function
@ -86,7 +85,7 @@ impl<'tcx> LateLintPass<'tcx> for MyTypeImpl {
[`check_impl_item`]: https://doc.rust-lang.org/stable/nightly-rustc/rustc_lint/trait.LateLintPass.html#method.check_impl_item [`check_impl_item`]: https://doc.rust-lang.org/stable/nightly-rustc/rustc_lint/trait.LateLintPass.html#method.check_impl_item
[`ExprKind`]: https://doc.rust-lang.org/beta/nightly-rustc/rustc_hir/hir/enum.ExprKind.html [`ExprKind`]: https://doc.rust-lang.org/beta/nightly-rustc/rustc_hir/hir/enum.ExprKind.html
[Ident]: https://doc.rust-lang.org/beta/nightly-rustc/rustc_span/symbol/struct.Ident.html [`Ident`]: https://doc.rust-lang.org/beta/nightly-rustc/rustc_span/symbol/struct.Ident.html
[`ImplItem`]: https://doc.rust-lang.org/stable/nightly-rustc/rustc_hir/hir/struct.ImplItem.html [`ImplItem`]: https://doc.rust-lang.org/stable/nightly-rustc/rustc_hir/hir/struct.ImplItem.html
[`LateLintPass`]: https://doc.rust-lang.org/stable/nightly-rustc/rustc_lint/trait.LateLintPass.html [`LateLintPass`]: https://doc.rust-lang.org/stable/nightly-rustc/rustc_lint/trait.LateLintPass.html
[`MethodCall`]: https://doc.rust-lang.org/beta/nightly-rustc/rustc_hir/hir/enum.ExprKind.html#variant.MethodCall [`MethodCall`]: https://doc.rust-lang.org/beta/nightly-rustc/rustc_hir/hir/enum.ExprKind.html#variant.MethodCall