feat(ci): lint against usages of variables with underscore

Prefixing a variable with an underscore (`_`) in Rust indicates that it is not used. Through refactorings, it can sometimes happen that we do end up using such a variable. In this case, the underscore should be removed.

Clippy can help us with this.

Pull-Request: #3484.

.cargo/config.toml

@@ -1,3 +1,3 @@
 [alias]
 # Temporary solution to have clippy config in a single place until https://github.com/rust-lang/rust-clippy/blob/master/doc/roadmap-2021.md#lintstoml-configuration is shipped.
-custom-clippy = "clippy --workspace --all-features --all-targets -- -A clippy::type_complexity -A clippy::pedantic -D warnings"
+custom-clippy = "clippy --workspace --all-features --all-targets -- -A clippy::type_complexity -A clippy::pedantic -W clippy::used_underscore_binding -D warnings"

core/src/transport/memory.rs

@@ -641,14 +641,14 @@ mod tests {
         };
 
         let dialer = async move {
-            let _chan = MemoryTransport::default()
+            let chan = MemoryTransport::default()
                 .dial(listener_addr_cloned)
                 .unwrap()
                 .await
                 .unwrap();
 
             should_terminate.await.unwrap();
-            drop(_chan);
+            drop(chan);
             terminated.send(()).unwrap();
         };
 

protocols/autonat/src/behaviour.rs

@@ -497,13 +497,13 @@ impl NetworkBehaviour for Behaviour {
 
     fn handle_established_inbound_connection(
         &mut self,
-        _connection_id: ConnectionId,
+        connection_id: ConnectionId,
         peer: PeerId,
         local_addr: &Multiaddr,
         remote_addr: &Multiaddr,
     ) -> Result<THandler<Self>, ConnectionDenied> {
         self.inner.handle_established_inbound_connection(
-            _connection_id,
+            connection_id,
             peer,
             local_addr,
             remote_addr,
@@ -512,28 +512,28 @@ impl NetworkBehaviour for Behaviour {
 
     fn handle_pending_outbound_connection(
         &mut self,
-        _connection_id: ConnectionId,
+        connection_id: ConnectionId,
         maybe_peer: Option<PeerId>,
-        _addresses: &[Multiaddr],
-        _effective_role: Endpoint,
+        addresses: &[Multiaddr],
+        effective_role: Endpoint,
     ) -> Result<Vec<Multiaddr>, ConnectionDenied> {
         self.inner.handle_pending_outbound_connection(
-            _connection_id,
+            connection_id,
             maybe_peer,
-            _addresses,
-            _effective_role,
+            addresses,
+            effective_role,
         )
     }
 
     fn handle_established_outbound_connection(
         &mut self,
-        _connection_id: ConnectionId,
+        connection_id: ConnectionId,
         peer: PeerId,
         addr: &Multiaddr,
         role_override: Endpoint,
     ) -> Result<THandler<Self>, ConnectionDenied> {
         self.inner
-            .handle_established_outbound_connection(_connection_id, peer, addr, role_override)
+            .handle_established_outbound_connection(connection_id, peer, addr, role_override)
     }
 
     fn on_swarm_event(&mut self, event: FromSwarm<Self::ConnectionHandler>) {

protocols/autonat/tests/test_server.rs

@@ -284,11 +284,11 @@ async fn test_throttle_global_max() {
             ..Default::default()
         }))
         .await;
-        let mut _handles = Vec::new();
+        let mut handles = Vec::new();
         for _ in 0..2 {
-            let (_handle, rx) = oneshot::channel();
+            let (handle, rx) = oneshot::channel();
             spawn_client(true, false, server_id, server_addr.clone(), rx).await;
-            _handles.push(_handle);
+            handles.push(handle);
         }
 
         let (first_probe_id, first_peer_id) = match next_event(&mut server).await {

protocols/gossipsub/src/peer_score.rs

@@ -563,7 +563,7 @@ impl PeerScore {
         }
     }
 
-    pub fn validate_message(&mut self, _from: &PeerId, msg_id: &MessageId, topic_hash: &TopicHash) {
+    pub fn validate_message(&mut self, from: &PeerId, msg_id: &MessageId, topic_hash: &TopicHash) {
         // adds an empty record with the message id
         self.deliveries
             .entry(msg_id.clone())
@@ -572,12 +572,12 @@ impl PeerScore {
         if let Some(callback) = self.message_delivery_time_callback {
             if self
                 .peer_stats
-                .get(_from)
+                .get(from)
                 .and_then(|s| s.topics.get(topic_hash))
                 .map(|ts| ts.in_mesh())
                 .unwrap_or(false)
             {
-                callback(_from, topic_hash, 0.0);
+                callback(from, topic_hash, 0.0);
             }
         }
     }

swarm/src/behaviour/either.rs

@@ -48,20 +48,20 @@ where
 
     fn handle_established_inbound_connection(
         &mut self,
-        _connection_id: ConnectionId,
+        connection_id: ConnectionId,
         peer: PeerId,
         local_addr: &Multiaddr,
         remote_addr: &Multiaddr,
     ) -> Result<THandler<Self>, ConnectionDenied> {
         let handler = match self {
             Either::Left(inner) => Either::Left(inner.handle_established_inbound_connection(
-                _connection_id,
+                connection_id,
                 peer,
                 local_addr,
                 remote_addr,
             )?),
             Either::Right(inner) => Either::Right(inner.handle_established_inbound_connection(
-                _connection_id,
+                connection_id,
                 peer,
                 local_addr,
                 remote_addr,
@@ -73,23 +73,23 @@ where
 
     fn handle_pending_outbound_connection(
         &mut self,
-        _connection_id: ConnectionId,
+        connection_id: ConnectionId,
         maybe_peer: Option<PeerId>,
-        _addresses: &[Multiaddr],
-        _effective_role: Endpoint,
+        addresses: &[Multiaddr],
+        effective_role: Endpoint,
     ) -> Result<Vec<Multiaddr>, ConnectionDenied> {
         let addresses = match self {
             Either::Left(inner) => inner.handle_pending_outbound_connection(
-                _connection_id,
+                connection_id,
                 maybe_peer,
-                _addresses,
-                _effective_role,
+                addresses,
+                effective_role,
             )?,
             Either::Right(inner) => inner.handle_pending_outbound_connection(
-                _connection_id,
+                connection_id,
                 maybe_peer,
-                _addresses,
-                _effective_role,
+                addresses,
+                effective_role,
             )?,
         };
 
@@ -98,20 +98,20 @@ where
 
     fn handle_established_outbound_connection(
         &mut self,
-        _connection_id: ConnectionId,
+        connection_id: ConnectionId,
         peer: PeerId,
         addr: &Multiaddr,
         role_override: Endpoint,
     ) -> Result<THandler<Self>, ConnectionDenied> {
         let handler = match self {
             Either::Left(inner) => Either::Left(inner.handle_established_outbound_connection(
-                _connection_id,
+                connection_id,
                 peer,
                 addr,
                 role_override,
             )?),
             Either::Right(inner) => Either::Right(inner.handle_established_outbound_connection(
-                _connection_id,
+                connection_id,
                 peer,
                 addr,
                 role_override,

swarm/src/behaviour/toggle.rs

@@ -90,7 +90,7 @@ where
 
     fn handle_established_inbound_connection(
         &mut self,
-        _connection_id: ConnectionId,
+        connection_id: ConnectionId,
         peer: PeerId,
         local_addr: &Multiaddr,
         remote_addr: &Multiaddr,
@@ -101,7 +101,7 @@ where
         };
 
         let handler = inner.handle_established_inbound_connection(
-            _connection_id,
+            connection_id,
             peer,
             local_addr,
             remote_addr,
@@ -114,10 +114,10 @@ where
 
     fn handle_pending_outbound_connection(
         &mut self,
-        _connection_id: ConnectionId,
+        connection_id: ConnectionId,
         maybe_peer: Option<PeerId>,
-        _addresses: &[Multiaddr],
-        _effective_role: Endpoint,
+        addresses: &[Multiaddr],
+        effective_role: Endpoint,
     ) -> Result<Vec<Multiaddr>, ConnectionDenied> {
         let inner = match self.inner.as_mut() {
             None => return Ok(vec![]),
@@ -125,10 +125,10 @@ where
         };
 
         let addresses = inner.handle_pending_outbound_connection(
-            _connection_id,
+            connection_id,
             maybe_peer,
-            _addresses,
-            _effective_role,
+            addresses,
+            effective_role,
         )?;
 
         Ok(addresses)
@@ -136,7 +136,7 @@ where
 
     fn handle_established_outbound_connection(
         &mut self,
-        _connection_id: ConnectionId,
+        connection_id: ConnectionId,
         peer: PeerId,
         addr: &Multiaddr,
         role_override: Endpoint,
@@ -147,7 +147,7 @@ where
         };
 
         let handler = inner.handle_established_outbound_connection(
-            _connection_id,
+            connection_id,
             peer,
             addr,
             role_override,

swarm/src/handler/pending.rs

@@ -92,7 +92,7 @@ impl ConnectionHandler for PendingConnectionHandler {
                 info: _info,
             }) => {
                 void::unreachable(protocol);
-                #[allow(unreachable_code)]
+                #[allow(unreachable_code, clippy::used_underscore_binding)]
                 {
                     void::unreachable(_info);
                 }

swarm/src/test.rs

@@ -420,19 +420,19 @@ where
 
     fn handle_established_inbound_connection(
         &mut self,
-        _connection_id: ConnectionId,
+        connection_id: ConnectionId,
         peer: PeerId,
         local_addr: &Multiaddr,
         remote_addr: &Multiaddr,
     ) -> Result<THandler<Self>, ConnectionDenied> {
         self.handle_established_inbound_connection.push((
             peer,
-            _connection_id,
+            connection_id,
             local_addr.clone(),
             remote_addr.clone(),
         ));
         self.inner.handle_established_inbound_connection(
-            _connection_id,
+            connection_id,
             peer,
             local_addr,
             remote_addr,
@@ -441,28 +441,28 @@ where
 
     fn handle_pending_outbound_connection(
         &mut self,
-        _connection_id: ConnectionId,
+        connection_id: ConnectionId,
         maybe_peer: Option<PeerId>,
-        _addresses: &[Multiaddr],
-        _effective_role: Endpoint,
+        addresses: &[Multiaddr],
+        effective_role: Endpoint,
     ) -> Result<Vec<Multiaddr>, ConnectionDenied> {
         self.handle_pending_outbound_connection.push((
             maybe_peer,
-            _addresses.to_vec(),
-            _effective_role,
-            _connection_id,
+            addresses.to_vec(),
+            effective_role,
+            connection_id,
         ));
         self.inner.handle_pending_outbound_connection(
-            _connection_id,
+            connection_id,
             maybe_peer,
-            _addresses,
-            _effective_role,
+            addresses,
+            effective_role,
         )
     }
 
     fn handle_established_outbound_connection(
         &mut self,
-        _connection_id: ConnectionId,
+        connection_id: ConnectionId,
         peer: PeerId,
         addr: &Multiaddr,
         role_override: Endpoint,
@@ -471,10 +471,10 @@ where
             peer,
             addr.clone(),
             role_override,
-            _connection_id,
+            connection_id,
         ));
         self.inner
-            .handle_established_outbound_connection(_connection_id, peer, addr, role_override)
+            .handle_established_outbound_connection(connection_id, peer, addr, role_override)
     }
 
     fn on_swarm_event(&mut self, event: FromSwarm<Self::ConnectionHandler>) {

swarm/tests/swarm_derive.rs

@@ -49,7 +49,12 @@ fn one_field() {
         ping: ping::Behaviour,
     }
 
-    #[allow(dead_code, unreachable_code, clippy::diverging_sub_expression)]
+    #[allow(
+        dead_code,
+        unreachable_code,
+        clippy::diverging_sub_expression,
+        clippy::used_underscore_binding
+    )]
     fn foo() {
         let _out_event: <Foo as NetworkBehaviour>::OutEvent = unimplemented!();
         match _out_event {
@@ -68,7 +73,12 @@ fn two_fields() {
         identify: identify::Behaviour,
     }
 
-    #[allow(dead_code, unreachable_code, clippy::diverging_sub_expression)]
+    #[allow(
+        dead_code,
+        unreachable_code,
+        clippy::diverging_sub_expression,
+        clippy::used_underscore_binding
+    )]
     fn foo() {
         let _out_event: <Foo as NetworkBehaviour>::OutEvent = unimplemented!();
         match _out_event {
@@ -91,7 +101,12 @@ fn three_fields() {
         kad: libp2p_kad::Kademlia<libp2p_kad::record::store::MemoryStore>,
     }
 
-    #[allow(dead_code, unreachable_code, clippy::diverging_sub_expression)]
+    #[allow(
+        dead_code,
+        unreachable_code,
+        clippy::diverging_sub_expression,
+        clippy::used_underscore_binding
+    )]
     fn foo() {
         let _out_event: <Foo as NetworkBehaviour>::OutEvent = unimplemented!();
         match _out_event {
@@ -219,7 +234,12 @@ fn nested_derives_with_import() {
         foo: Foo,
     }
 
-    #[allow(dead_code, unreachable_code, clippy::diverging_sub_expression)]
+    #[allow(
+        dead_code,
+        unreachable_code,
+        clippy::diverging_sub_expression,
+        clippy::used_underscore_binding
+    )]
     fn foo() {
         let _out_event: <Bar as NetworkBehaviour>::OutEvent = unimplemented!();
         match _out_event {
@@ -259,7 +279,12 @@ fn custom_event_emit_event_through_poll() {
         identify: identify::Behaviour,
     }
 
-    #[allow(dead_code, unreachable_code, clippy::diverging_sub_expression)]
+    #[allow(
+        dead_code,
+        unreachable_code,
+        clippy::diverging_sub_expression,
+        clippy::used_underscore_binding
+    )]
     async fn bar() {
         require_net_behaviour::<Foo>();