Add must_use.

LukeMathWalker · Sep 5, 2021 · 76601e3 · 76601e3
1 parent ea5cc89
commit 76601e3
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/mock_server/bare_server.rs b/src/mock_server/bare_server.rs
@@ -175,6 +175,11 @@ pub(super) enum RequestRecording {
 /// To improve your debugging experience it is strongly recommended to use [`Mock::named`] to assign a unique
 /// identifier to your scoped [`Mock`]s, which will in turn be referenced in the panic message if their expectations are
 /// not met.
+#[must_use =
+    "All *_scoped methods return a `MockGuard`.
+This guard MUST be bound to a variable (e.g. _mock_guard), \
+otherwise the mock will immediately be unmounted (and its expectations checked).
+Check `wiremock`'s documentation on scoped mocks for more details."]
 pub struct MockGuard {
     mock_id: MockId,
     server_state: Arc<RwLock<MockServerState>>,