Clippy lints / Nursery
Clippy lint · Nursery · checked with Clippy 0.1.99
clippy::future_not_send: future cannot be sent between threads safely
What it meansThis lint requires Future implementations returned from functions and methods to implement the Send marker trait, ignoring type parameters. If a function is generic and its Future conditionally implements Send based on a generic parameter then it is considered Send and no warning is emitted. This can be used by library authors (public and internal) to ensure their functions are compatible with both multi-threaded runtimes that require Send futures, as well as single-threaded runtimes where callers may choose !Send types for generic parameters. It is in the nursery group and off by default.
What you see
warning: future cannot be sent between threads safely --> main.rs:3:44 | 3 | async fn not_send(bytes: std::rc::Rc<[u8]>) {} | ^ future returned by `not_send` is not `Send` | note: captured value is not `Send` --> main.rs:3:19 | 3 | async fn not_send(bytes: std::rc::Rc<[u8]>) {} | ^^^^^ has type `std::rc::Rc<[u8]>` which is not `Send` = note: `std::rc::Rc<[u8]>` doesn't implement `std::marker::Send` = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#future_not_send = note: `-W clippy::future-not-send` implied by `-W clippy::nursery`
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?
A Future implementation captures some state that it needs to eventually produce its final value. When targeting a multithreaded executor (which is the norm on non-embedded devices) this means that this state may need to be transported to other threads, in other words the whole Future needs to implement the Send marker trait. If it does not, then the resulting Future cannot be submitted to a thread pool in the end user’s code. Especially for generic functions it can be confusing to leave the discovery of this problem to the end user: the reported error location will be far from its cause and can in many cases not even be fixed without modifying the library where the offending Future implementation is produced.
New lints still being finished. Off by default and may have false positives.
How to fix it
Clippy does not fix this one automatically. Change the code by hand:
Flagged
async fn not_send(bytes: std::rc::Rc<[u8]>) {}
Write this instead
async fn is_send(bytes: std::sync::Arc<[u8]>) {}
Turn it off, or on
It is off by default. To use it, set it to warn or deny:
Whole crate (Cargo.toml)
[lints.clippy]
future_not_send = "warn"In code
#![warn(clippy::future_not_send)]One run
cargo clippy -- -W clippy::future-not-sendThe [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.
Clippy's own documentation
What it does
This lint requires Future implementations returned from
functions and methods to implement the Send marker trait,
ignoring type parameters.
If a function is generic and its Future conditionally implements Send
based on a generic parameter then it is considered Send and no warning is emitted.
This can be used by library authors (public and internal) to ensure
their functions are compatible with both multi-threaded runtimes that require Send futures,
as well as single-threaded runtimes where callers may choose !Send types
for generic parameters.
Why is this bad?
A Future implementation captures some state that it
needs to eventually produce its final value. When targeting a multithreaded
executor (which is the norm on non-embedded devices) this means that this
state may need to be transported to other threads, in other words the
whole Future needs to implement the Send marker trait. If it does not,
then the resulting Future cannot be submitted to a thread pool in the
end user’s code.
Especially for generic functions it can be confusing to leave the discovery of this problem to the end user: the reported error location will be far from its cause and can in many cases not even be fixed without modifying the library where the offending Future implementation is produced.
Example
async fn not_send(bytes: std::rc::Rc<[u8]>) {}
Use instead:
async fn is_send(bytes: std::sync::Arc<[u8]>) {}
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- redundant_cloneChecks for a redundant clone() (and its relatives) which clones an owned value that is going to be dropped without further use
- empty_enumsChecks for enums with no variants, which therefore are uninhabited types (cannot be instantiated). As of this writing, the never_type is still a nightly-only experimental API. Therefore, this lint is only triggered if #![feature(never_type)] is enabled
- equatable_if_letChecks for pattern matchings that can be expressed using equality
- fallible_impl_fromconsider implementing `TryFrom` instead
- imprecise_flopscube-root of a number can be computed more accurately
- iter_on_empty_collectionsChecks for calls to iter, iter_mut or into_iter on empty collections
- iter_on_single_items`iter` call on a collection with only one item
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::redundant_cloneChecks for a redundant clone() (and its relatives) which clones an owned value that is going to be dropped without further useRead it next →Did this answer your question?