From cefd22b8846ab005b311d5a3bc3d90c7e3a67872 Mon Sep 17 00:00:00 2001
From: stormshield-frb <144998884+stormshield-frb@users.noreply.github.com>
Date: Thu, 29 Aug 2024 16:58:41 +0200
Subject: [PATCH] feat(kad): add `mode` getter on `Behaviour` (#5573)

## Description

Small PR adding a getter for the `mode` attribute of the
`kad::Behaviour` in order to get the mode that the DHT is operating in,
at the moment.

In our project, we needed to expose an API endpoint which included the
mode that the DHT was operating. Having a getter was necessary so we are
upstreaming this change.

## Notes & open questions

<!--
Any notes, remarks or open questions you have to make about the PR which
don't need to go into the final commit message.
-->

## Change checklist

<!-- Please add a Changelog entry in the appropriate crates and bump the
crate versions if needed. See
<https://github.com/libp2p/rust-libp2p/blob/master/docs/release.md#development-between-releases>-->

- [x] I have performed a self-review of my own code
- [x] I have made corresponding changes to the documentation
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [x] A changelog entry has been made in the appropriate crates
---
 protocols/kad/CHANGELOG.md     | 3 +++
 protocols/kad/src/behaviour.rs | 5 +++++
 2 files changed, 8 insertions(+)

diff --git a/protocols/kad/CHANGELOG.md b/protocols/kad/CHANGELOG.md
index 12ccca2d7f1..d0ab7986aad 100644
--- a/protocols/kad/CHANGELOG.md
+++ b/protocols/kad/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 - Expose a kad query facility allowing specify num_results dynamicly.
   See [PR 5555](https://github.com/libp2p/rust-libp2p/pull/5555).
+- Add `mode` getter on `Behaviour`.
+  See [PR 5573](https://github.com/libp2p/rust-libp2p/pull/5573).
+  
 
 ## 0.46.2
 
diff --git a/protocols/kad/src/behaviour.rs b/protocols/kad/src/behaviour.rs
index 50715c53c74..0b15e507ba4 100644
--- a/protocols/kad/src/behaviour.rs
+++ b/protocols/kad/src/behaviour.rs
@@ -1111,6 +1111,11 @@ where
         }
     }
 
+    /// Get the [`Mode`] in which the DHT is currently operating.
+    pub fn mode(&self) -> Mode {
+        self.mode
+    }
+
     fn reconfigure_mode(&mut self) {
         if self.connections.is_empty() {
             return;