From 9448571f9e41723d3fa0584b7231dc28f1e23bc6 Mon Sep 17 00:00:00 2001 From: Rob Ede Date: Sat, 15 Jan 2022 23:55:40 +0000 Subject: [PATCH] fix docs --- src/guard.rs | 8 ++++---- src/request_data.rs | 2 +- src/response/response.rs | 4 ++-- src/service.rs | 3 --- 4 files changed, 7 insertions(+), 10 deletions(-) diff --git a/src/guard.rs b/src/guard.rs index c21dccec1..596b9f9fe 100644 --- a/src/guard.rs +++ b/src/guard.rs @@ -69,15 +69,15 @@ impl<'a> GuardContext<'a> { self.req.head() } - /// Returns reference to the request-local data container. + /// Returns reference to the request-local data/extensions container. #[inline] - pub fn extensions(&self) -> Ref<'a, Extensions> { + pub fn req_data(&self) -> Ref<'a, Extensions> { self.req.extensions() } - /// Returns mutable reference to the request-local data container. + /// Returns mutable reference to the request-local data/extensions container. #[inline] - pub fn extensions_mut(&self) -> RefMut<'a, Extensions> { + pub fn req_data_mut(&self) -> RefMut<'a, Extensions> { self.req.extensions_mut() } diff --git a/src/request_data.rs b/src/request_data.rs index 7f96bafec..68103a7e9 100644 --- a/src/request_data.rs +++ b/src/request_data.rs @@ -20,7 +20,7 @@ use crate::{ /// # Mutating Request Data /// Note that since extractors must output owned data, only types that `impl Clone` can use this /// extractor. A clone is taken of the required request data and can, therefore, not be directly -/// mutated in-place. To mutate request data, continue to use [`HttpRequest::req_data_mut`] or +/// mutated in-place. To mutate request data, continue to use [`HttpRequest::extensions_mut`] or /// re-insert the cloned data back into the extensions map. A `DerefMut` impl is intentionally not /// provided to make this potential foot-gun more obvious. /// diff --git a/src/response/response.rs b/src/response/response.rs index fc383fbc6..4aba4b623 100644 --- a/src/response/response.rs +++ b/src/response/response.rs @@ -168,13 +168,13 @@ impl HttpResponse { self.res.keep_alive() } - /// Responses extensions + /// Returns reference to the response-local data/extensions container. #[inline] pub fn extensions(&self) -> Ref<'_, Extensions> { self.res.extensions() } - /// Mutable reference to a the response's extensions + /// Returns reference to the response-local data/extensions container. #[inline] pub fn extensions_mut(&mut self) -> RefMut<'_, Extensions> { self.res.extensions_mut() diff --git a/src/service.rs b/src/service.rs index a8a86b51a..03ea0b97b 100644 --- a/src/service.rs +++ b/src/service.rs @@ -309,18 +309,15 @@ impl HttpMessage for ServiceRequest { type Stream = BoxedPayloadStream; #[inline] - /// Returns Request's headers. fn headers(&self) -> &HeaderMap { &self.head().headers } - /// Request extensions #[inline] fn extensions(&self) -> Ref<'_, Extensions> { self.req.extensions() } - /// Mutable reference to a the request's extensions #[inline] fn extensions_mut(&self) -> RefMut<'_, Extensions> { self.req.extensions_mut()