rust-lang / rust-lang/rust-clippy

`std::io::Empty` that is never read from

Open
#11,400 1 comment 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

If Empty is constructed yet its implementations of Read/BufRead are never required, we should suggest Sink instead which conveys this purpose better.

We also need to make sure some access does not require a trait outside of std that Sink doesn't implement.

Advantage
  • This restricts it from being read from in the future, if that's undesirable.
Drawbacks
  • This restricts it from being read from in the future, if that's desirable.
Example
use std::io::{prelude::*, empty};

fn b<T: Read>(t: &T) {}

fn a() {
    let mut empty_unused = empty();
    empty_unused.write(&[0]);

    let mut empty_used1 = empty();
    empty_used1.write(&[0]);
    empty_used1.read(&mut []);
    
    let mut empty_used2 = empty();
    b(&empty_used2);
}

Could be written as:

use std::io::{prelude::*, empty, sink};

fn b<T: Read>(t: &T) {}

fn a() {
    let mut empty_unused = sink();
    empty_unused.write(&[0]);

    let mut empty_used1 = empty();
    empty_used1.write(&[0]);
    empty_used1.read(&mut []);
    
    let mut empty_used2 = empty();
    b(&empty_used2);
}

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

Start at the std::io::empty and std::io::sink entry points, and review how Empty implements Read and BufRead while Sink does not. Check the examples for write-only use, explicit reads, and generic Read access, including whether external traits affect the distinction. Done means the proposed lint handles these cases without restricting intended future reads.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.