Mirrors/rust-clippy
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-clippy synced 2024-09-21 07:01:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

mention restriction to exported types as a limitation

Browse source
This commit is contained in:
y21 2023-10-26 01:07:20 +02:00
parent 3c501e4e41
commit 45f94c7598
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
clippy_lints/src/iter_without_into_iter.rs
View file

@ -19,6 +19,11 @@ declare_clippy_lint! {
/// It's not bad, but having them is idiomatic and allows the type to be used in for loops directly
/// (`for val in &iter {}`), without having to first call `iter()` or `iter_mut()`.
///
/// ### Limitations
/// This lint is restricted to exported types only, because it is aimed at guiding towards an
/// idiomatic, _public_ API.
/// Implementing the `IntoIterator` trait when it is not needed or used anywhere doesn't help or improve the code.
///
/// ### Example
/// ```rust
/// struct MySlice<'a>(&'a [u8]);
@ -61,6 +66,12 @@ declare_clippy_lint! {
/// by just calling `.iter()`, instead of the more awkward `<&Type>::into_iter` or `(&val).into_iter()` syntax
/// in case of ambiguity with another `IntoIterator` impl.
///
/// ### Limitations
/// This lint is restricted to exported types only, because it is aimed at guiding towards an
/// idiomatic, _public_ API.
/// Adding an `iter` or `iter_mut` for private types when it is not needed or used doesn't improve code,
/// and in fact, is linted against by the `dead_code` lint.
///
/// ### Example
/// ```rust
/// struct MySlice<'a>(&'a [u8]);