Email me

Clippy lints / Style

Clippy lint · Style · checked with Clippy 0.1.99

clippy::toplevel_ref_arg: `ref` directly on a function parameter does not prevent taking ownership of the passed argument. Consider using a reference type instead

What it meansChecks for function arguments and let bindings denoted as ref. It is in the style group and warns by default.

What you see

warning: `ref` directly on a function parameter does not prevent taking ownership of the passed argument. Consider using a reference type instead
 --> main.rs:3:8
  |
3 | fn foo(ref _x: u8) {}
  |        ^^^^^^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#toplevel_ref_arg
  = note: `#[warn(clippy::toplevel_ref_arg)]` 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?

The ref declaration makes the function take an owned value, but turns the argument into a reference (which means that the value is destroyed when exiting the function). This adds not much value: either take a reference type, or take an owned value and create references in the body. For let bindings, let x = &foo; is preferred over let ref x = foo. The type of x is more obvious with the former.

Code that works but is not idiomatic Rust. Warns by default.

How to fix it

Clippy can fix this one for you: run cargo clippy --fix (add --allow-dirty if you have uncommitted changes). Review the diff before you commit.

Flagged

fn foo(ref _x: u8) {}

Write this instead

fn foo(_x: &u8) {}

Turn it off, or on

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

On one item

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

Whole crate (Cargo.toml)

[lints.clippy]
toplevel_ref_arg = "allow"

One run

cargo clippy -- -A clippy::toplevel-ref-arg

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.

Stylegroup
warndefault level
yesfixed by cargo clippy --fix
pre 1.29.0added in Rust

Clippy's own documentation

What it does

Checks for function arguments and let bindings denoted as ref.

Why is this bad?

The ref declaration makes the function take an owned value, but turns the argument into a reference (which means that the value is destroyed when exiting the function). This adds not much value: either take a reference type, or take an owned value and create references in the body.

For let bindings, let x = &foo; is preferred over let ref x = foo. The type of x is more obvious with the former.

Known problems

If the argument is dereferenced within the function, removing the ref will lead to errors. This can be fixed by removing the dereferences, e.g., changing *x to x within the function.

Example

fn foo(ref _x: u8) {}

Use instead:

fn foo(_x: &u8) {}

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

Related lints

All 847 Clippy lints · Rust compiler errors · Cargo.toml checker

Up next

Related lintclippy::needless_returnunneeded `return` statementRead it next →

Did this answer your question?

Get the receipts by email.

What my AI agents tried this week, with the real numbers: what worked, what flopped, what made money. One email when there is something worth reading.

No spam, never sold. Every email has a one-click unsubscribe.

Popular in the shop

All 124 tools →

Browse: Bundles and kitsHome, family and schoolMoney and businessAI toolsSports and fitnessMaking and hobbiesFood and drinkIndie dev and launchTrading and quant

Free: Landing page teardown iPhone app cost calculator LLM API cost calculator Paid online: $49 Launch Check App builds Articles FAQ