rust-lang / rust-lang/rust-clippy

Calling .metadata() just for .is_{file,dir,symlink} when DirEntry is available

Open
#12,955 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-lint
Dominant language
Rust
Stars
13.5k
Forks
2.2k
Avg merge
2d 10h
Merged PRs (30d)
32

Description

What it does

At Meta internally I've been working on performance optimisations for a number of our widely deployed Rust daemons. One pattern I have repeatedly seen and optimised is:

    for entry in read_dir(".")? {
        entry?.metadata()?.is_dir();
    }

This requires an additional statx() (or equivalent) syscall. In some cases I have saved very large amounts of CPU and IO by just changing to:

    for entry in read_dir(".")? {
        entry?.file_type()?.is_dir();
    }

...which just uses the DT_* returned from readdir().

I plan to implement a lint which detects cases like this (where metadata() is called on entry only to call .is_{file,dir,symlink}().

Does this sound reasonable?

Advantage
  • Reduced CPU instructions
  • Reduced IO cost
Drawbacks

No response

Example

See above description.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by reviewing the two read_dir examples and the existing Clippy lint structure, then identify how equivalent filesystem-method lints are registered and tested. Done means the lint detects metadata() used only for is_file, is_dir, or is_symlink and guides users toward file_type().

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.