From 549be547accdb13037bf3ef60310ca30d045dce0 Mon Sep 17 00:00:00 2001
From: "Tobin C. Harding" <me@tobin.cc>
Date: Mon, 9 Dec 2024 16:50:16 +1100
Subject: [PATCH] primitives: Add must_use

Enable lint `clippy::return_self_not_must_use` and add attribute
`must_use` as required.

Also run the linter with `clippy::must_use_candidate` enabled and
manually check every warning site.

While we are at it change the current `must_use` usages to have no
message. We can always add a message later if needed.
---
 primitives/src/block.rs           | 1 +
 primitives/src/lib.rs             | 3 +++
 primitives/src/opcodes.rs         | 2 ++
 primitives/src/script/borrowed.rs | 2 +-
 primitives/src/script/owned.rs    | 2 +-
 primitives/src/witness.rs         | 1 +
 6 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/primitives/src/block.rs b/primitives/src/block.rs
index 22d31c9ed..7736fcf8f 100644
--- a/primitives/src/block.rs
+++ b/primitives/src/block.rs
@@ -77,6 +77,7 @@ impl Block<Unchecked> {
     /// Ignores block validation logic and just assumes you know what you are doing.
     ///
     /// You should only use this function if you trust the block i.e., it comes from a trusted node.
+    #[must_use]
     pub fn assume_checked(self, witness_root: Option<WitnessMerkleNode>) -> Block<Checked> {
         Block {
             header: self.header,
diff --git a/primitives/src/lib.rs b/primitives/src/lib.rs
index b8a5204de..f3cd95a7a 100644
--- a/primitives/src/lib.rs
+++ b/primitives/src/lib.rs
@@ -16,6 +16,9 @@
 #![warn(missing_docs)]
 #![warn(deprecated_in_future)]
 #![doc(test(attr(warn(unused))))]
+// Pedantic lints that we enforce.
+// #![warn(clippy::must_use_candidate)]
+#![warn(clippy::return_self_not_must_use)]
 // Exclude lints we don't think are valuable.
 #![allow(clippy::needless_question_mark)] // https://github.com/rust-bitcoin/rust-bitcoin/pull/2134
 #![allow(clippy::manual_range_contains)] // More readable than clippy's format.
diff --git a/primitives/src/opcodes.rs b/primitives/src/opcodes.rs
index 498713fe2..bd922e22c 100644
--- a/primitives/src/opcodes.rs
+++ b/primitives/src/opcodes.rs
@@ -351,6 +351,7 @@ pub enum ClassifyContext {
 impl Opcode {
     /// Classifies an Opcode into a broad class.
     #[inline]
+    #[must_use]
     pub fn classify(self, ctx: ClassifyContext) -> Class {
         match (self, ctx) {
             // 3 opcodes illegal in all contexts
@@ -424,6 +425,7 @@ impl Opcode {
     ///
     /// Returns `None` if `self` is not a PUSHNUM.
     #[inline]
+    #[must_use]
     pub const fn decode_pushnum(self) -> Option<u8> {
         const START: u8 = OP_PUSHNUM_1.code;
         const END: u8 = OP_PUSHNUM_16.code;
diff --git a/primitives/src/script/borrowed.rs b/primitives/src/script/borrowed.rs
index a7ea5e2f0..e8ea04bcd 100644
--- a/primitives/src/script/borrowed.rs
+++ b/primitives/src/script/borrowed.rs
@@ -115,7 +115,7 @@ impl Script {
     pub fn is_empty(&self) -> bool { self.0.is_empty() }
 
     /// Converts a [`Box<Script>`](Box) into a [`ScriptBuf`] without copying or allocating.
-    #[must_use = "`self` will be dropped if the result is not used"]
+    #[must_use]
     pub fn into_script_buf(self: Box<Self>) -> ScriptBuf {
         let rw = Box::into_raw(self) as *mut [u8];
         // SAFETY: copied from `std`
diff --git a/primitives/src/script/owned.rs b/primitives/src/script/owned.rs
index 2e980afa1..8b640b106 100644
--- a/primitives/src/script/owned.rs
+++ b/primitives/src/script/owned.rs
@@ -48,7 +48,7 @@ impl ScriptBuf {
     /// when they are equal. If you know beforehand that you need to create a script of exact size
     /// use [`reserve_exact`](Self::reserve_exact) before adding data to the script so that the
     /// reallocation can be avoided.
-    #[must_use = "`self` will be dropped if the result is not used"]
+    #[must_use]
     #[inline]
     pub fn into_boxed_script(self) -> Box<Script> {
         // Copied from PathBuf::into_boxed_path
diff --git a/primitives/src/witness.rs b/primitives/src/witness.rs
index 4eb025bf4..b8f507dc5 100644
--- a/primitives/src/witness.rs
+++ b/primitives/src/witness.rs
@@ -103,6 +103,7 @@ impl Witness {
     pub fn is_empty(&self) -> bool { self.witness_elements == 0 }
 
     /// Returns a struct implementing [`Iterator`].
+    #[must_use = "returned iterator should be used"]
     pub fn iter(&self) -> Iter {
         Iter { inner: self.content.as_slice(), indices_start: self.indices_start, current_index: 0 }
     }