Skip to content

Commit

Permalink
Merge #11740
Browse files Browse the repository at this point in the history
11740: Insert #[must_use] in generate_is_empty_from_len r=lnicola a=Walther

Inserts `#[must_use]` for the generated `is_empty` methods. I also added the `#[must_use]` for the `len()` methods in the documentation examples and tests for this generator while at it, to make sure they too encourage the use of the annotation.

From discussion in #11736 and #11738

Co-authored-by: Walther <veeti.haapsamo@gmail.com>
  • Loading branch information
bors[bot] and Walther committed Mar 17, 2022
2 parents 502e30e + 217b305 commit 0a18e43
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
18 changes: 18 additions & 0 deletions crates/ide_assists/src/handlers/generate_is_empty_from_len.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ use crate::{
// struct MyStruct { data: Vec<String> }
//
// impl MyStruct {
// #[must_use]
// p$0ub fn len(&self) -> usize {
// self.data.len()
// }
Expand All @@ -27,10 +28,12 @@ use crate::{
// struct MyStruct { data: Vec<String> }
//
// impl MyStruct {
// #[must_use]
// pub fn len(&self) -> usize {
// self.data.len()
// }
//
// #[must_use]
// pub fn is_empty(&self) -> bool {
// self.len() == 0
// }
Expand Down Expand Up @@ -72,6 +75,7 @@ pub(crate) fn generate_is_empty_from_len(acc: &mut Assists, ctx: &AssistContext)
|builder| {
let code = r#"
#[must_use]
pub fn is_empty(&self) -> bool {
self.len() == 0
}"#
Expand Down Expand Up @@ -129,6 +133,7 @@ impl MyStruct {
struct MyStruct { data: Vec<String> }
impl MyStruct {
#[must_use]
p$0ub fn len(&self, _i: bool) -> usize {
self.data.len()
}
Expand All @@ -146,10 +151,12 @@ impl MyStruct {
struct MyStruct { data: Vec<String> }
impl MyStruct {
#[must_use]
p$0ub fn len(&self) -> usize {
self.data.len()
}
#[must_use]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
Expand All @@ -167,6 +174,7 @@ impl MyStruct {
struct MyStruct { data: Vec<String> }
impl MyStruct {
#[must_use]
p$0ub fn len(&self) -> u32 {
self.data.len()
}
Expand All @@ -183,6 +191,7 @@ impl MyStruct {
struct MyStruct { data: Vec<String> }
impl MyStruct {
#[must_use]
p$0ub fn len(&self) -> usize {
self.data.len()
}
Expand All @@ -192,10 +201,12 @@ impl MyStruct {
struct MyStruct { data: Vec<String> }
impl MyStruct {
#[must_use]
pub fn len(&self) -> usize {
self.data.len()
}
#[must_use]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
Expand All @@ -212,10 +223,12 @@ impl MyStruct {
struct MyStruct { data: Vec<String> }
impl MyStruct {
#[must_use]
pub fn new() -> Self {
Self { data: 0 }
}
#[must_use]
p$0ub fn len(&self) -> usize {
self.data.len()
}
Expand All @@ -229,14 +242,17 @@ impl MyStruct {
struct MyStruct { data: Vec<String> }
impl MyStruct {
#[must_use]
pub fn new() -> Self {
Self { data: 0 }
}
#[must_use]
pub fn len(&self) -> usize {
self.data.len()
}
#[must_use]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
Expand All @@ -257,12 +273,14 @@ impl MyStruct {
struct MyStruct { data: Vec<String> }
impl MyStruct {
#[must_use]
p$0ub fn len(&self) -> usize {
self.data.len()
}
}
impl MyStruct {
#[must_use]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
Expand Down
3 changes: 3 additions & 0 deletions crates/ide_assists/src/tests/generated.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1099,6 +1099,7 @@ fn doctest_generate_is_empty_from_len() {
struct MyStruct { data: Vec<String> }
impl MyStruct {
#[must_use]
p$0ub fn len(&self) -> usize {
self.data.len()
}
Expand All @@ -1108,10 +1109,12 @@ impl MyStruct {
struct MyStruct { data: Vec<String> }
impl MyStruct {
#[must_use]
pub fn len(&self) -> usize {
self.data.len()
}
#[must_use]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
Expand Down

0 comments on commit 0a18e43

Please sign in to comment.