Clippy lints / Pedantic
Clippy lint · Pedantic · checked with Clippy 0.1.99
clippy::option_option: use of `Option<Option<T>>`
What it meansChecks for usage of Option<Option<_>> in function signatures and type definitions It is in the pedantic group and off by default.
What you see
warning: use of `Option<Option<T>>` --> main.rs:3:18 | 3 | fn get_data() -> Option<Option<u32>> { | ^^^^^^^^^^^^^^^^^^^ | = help: consider using `Option<u32>`, or a custom enum if you need to distinguish all 3 cases = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#option_option = note: `-W clippy::option-option` implied by `-W clippy::pedantic`
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?
Option<_> represents an optional value. Option<Option<_>> represents an optional value which itself wraps an optional. This is logically the same thing as an optional value but has an unneeded extra level of wrapping. If you have a case where Some(Some(_)), Some(None) and None are distinct cases, consider a custom enum instead, with clear names for each case.
Stricter lints with some false positives. Off by default; opt in with clippy::pedantic.
How to fix it
Clippy does not fix this one automatically. Change the code by hand:
Flagged
fn get_data() -> Option<Option<u32>> {
None
}
Write this instead
pub enum Contents {
Data(Vec<u8>), // Was Some(Some(Vec<u8>))
NotYetFetched, // Was Some(None)
None, // Was None
}
fn get_data() -> Contents {
Contents::None
}
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]
option_option = "warn"In code
#![warn(clippy::option_option)]One run
cargo clippy -- -W clippy::option-optionThe [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.
Settings in clippy.toml
avoid-breaking-exported-api: Suppress lints whenever the suggested change would cause breakage for other crates.
Clippy's own documentation
What it does
Checks for usage of Option<Option<_>> in function signatures and type
definitions
Why is this bad?
Option<_> represents an optional value. Option<Option<_>>
represents an optional value which itself wraps an optional. This is logically the
same thing as an optional value but has an unneeded extra level of wrapping.
If you have a case where Some(Some(_)), Some(None) and None are distinct cases,
consider a custom enum instead, with clear names for each case.
Example
fn get_data() -> Option<Option<u32>> {
None
}
Better:
pub enum Contents {
Data(Vec<u8>), // Was Some(Some(Vec<u8>))
NotYetFetched, // Was Some(None)
None, // Was None
}
fn get_data() -> Contents {
Contents::None
}
Configuration
-
avoid-breaking-exported-api: Suppress lints whenever the suggested change would cause breakage for other crates.(default:
true)
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- too_many_linesChecks for functions with a large amount of lines
- missing_errors_docChecks the doc comments of publicly visible functions that return a Result type and warns if there is no # Errors section
- must_use_candidateChecks for public functions that have no #[must_use] attribute, but return something not already marked must-use, have no mutable arg and mutate no statics
- non_std_lazy_staticsLints when once_cell::sync::Lazy or lazy_static! are used to define a static variable, and suggests replacing such cases with std::sync::LazyLock instead. Note: This lint will not trigger in crate with no_std context, or with MSRV < 1.80.0
- nonminimal_boolChecks for boolean expressions that can be written more concisely
- option_as_ref_clonedcloning an `Option<_>` using `.as_ref().cloned()`
- overly_complex_bool_exprChecks for boolean expressions that contain terminals that can be eliminated
- ptr_as_ptr`as` casting between raw pointers without changing their constness
- ptr_cast_constness`as` casting between raw pointers while changing only its constness
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::too_many_linesChecks for functions with a large amount of linesRead it next →Did this answer your question?