mirrors/actix-web
1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2024-06-11 09:49:29 +00:00
Code Issues Projects Releases Wiki Activity

Update doc comment for HttpRequest::app_data (#1265)

Browse source 
* update doc comment for `HttpRequest::app_data`

* add `no_run` to doc comment

* add `ignore` to doc comment

* Update src/request.rs

Co-Authored-By: Yuki Okushi <huyuumi.dev@gmail.com>

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
This commit is contained in:
Jacob Brown 2020-01-10 12:55:20 -06:00 committed by Yuki Okushi
parent abb462ef85
commit 7c974ee668
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/request.rs
View file

@ -206,8 +206,14 @@ impl HttpRequest {
&self.0.config
}
/// Get an application data stored with `App::extension()` method during
/// application configuration.
/// Get an application data object stored with `App::data` or `App::app_data`
/// methods during application configuration.
///
/// If `App::data` was used to store object, use `Data<T>`:
///
/// ```rust,ignore
/// let opt_t = req.app_data::<Data<T>>();
/// ```
pub fn app_data<T: 'static>(&self) -> Option<&T> {
if let Some(st) = self.0.app_data.get::<T>() {
Some(&st)