Clippy lint · Suspicious · checked with Clippy 0.1.99

clippy::misnamed_getters: getter function appears to return the wrong field

What it meansChecks for getter methods that return a field that doesn’t correspond to the name of the method, when there is a field’s whose name matches that of the method. It is in the suspicious group and warns by default.

What you see

warning: getter function appears to return the wrong field
  --> main.rs:9:5
   |
 9 | /     fn a(&self) -> &str{
10 | |         &self.b
   | |         ------- help: consider using: `&self.a`
11 | |     }
   | |_____^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#misnamed_getters
   = note: `#[warn(clippy::misnamed_getters)]` on by default

Real output of Clippy 0.1.99 (Rust 1.99) on the example below. Names and line numbers in yours will differ.

Does it matter?

It is most likely that such a method is a bug caused by a typo or by copy-pasting.

Code that is most likely wrong or useless. Warns by default.

How to fix it

Clippy does not fix this one automatically (its suggestion may change behaviour, so it only shows it). Change the code by hand:

Flagged

struct A {
    a: String,
    b: String,
}

impl A {
    fn a(&self) -> &str{
        &self.b
    }
}

Write this instead

struct A {
    a: String,
    b: String,
}

impl A {
    fn a(&self) -> &str{
        &self.a
    }
}

Turn it off, or on

Allow it where it does not fit your code, as narrowly as you can:

On one item

#[allow(clippy::misnamed_getters)]
fn my_function() { /* ... */ }

Whole crate (Cargo.toml)

[lints.clippy]
misnamed_getters = "allow"

One run

cargo clippy -- -A clippy::misnamed-getters

The [lints] table needs Rust 1.74 or newer. In a workspace, put it under [workspace.lints.clippy] and add [lints] workspace = true to each member.

Suspiciousgroup

warndefault level

nofixed by cargo clippy --fix

1.67.0added in Rust

Clippy's own documentation

What it does

Checks for getter methods that return a field that doesn’t correspond to the name of the method, when there is a field’s whose name matches that of the method.

Why is this bad?

It is most likely that such a method is a bug caused by a typo or by copy-pasting.

Example

struct A {
    a: String,
    b: String,
}

impl A {
    fn a(&self) -> &str{
        &self.b
    }
}

Use instead:

struct A {
    a: String,
    b: String,
}

impl A {
    fn a(&self) -> &str{
        &self.a
    }
}

From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.

Up next

Also worth your time

Did this answer your question?