# resource.rs.html -- source
Source to the Rust file `src/resource.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323

    use std::ops::Deref;
    use std::rc::Rc;

    use futures::Future;
    use http::Method;
    use smallvec::SmallVec;

    use error::Error;
    use handler::{AsyncResult, FromRequest, Handler, Responder};
    use httprequest::HttpRequest;
    use httpresponse::HttpResponse;
    use middleware::Middleware;
    use pred;
    use route::Route;
    use router::ResourceDef;

    #[derive(Copy, Clone)]
    pub(crate) struct RouteId(usize);

    /// *Resource* is an entry in route table which corresponds to requested URL.
    ///
    /// Resource in turn has at least one route.
    /// Route consists of an object that implements `Handler` trait (handler)
    /// and list of predicates (objects that implement `Predicate` trait).
    /// Route uses builder-like pattern for configuration.
    /// During request handling, resource object iterate through all routes
    /// and check all predicates for specific route, if request matches all
    /// predicates route route considered matched and route handler get called.
    ///
    /// ```rust
    /// # extern crate actix_web;
    /// use actix_web::{App, HttpResponse, http};
    ///
    /// fn main() {
    ///     let app = App::new()
    ///         .resource(
    ///             "/", |r| r.method(http::Method::GET).f(|r| HttpResponse::Ok()))
    ///         .finish();
    /// }
    pub struct Resource<S = ()> {
        rdef: ResourceDef,
        routes: SmallVec<[Route<S>; 3]>,
        middlewares: Rc<Vec<Box<Middleware<S>>>>,
    }

    impl<S> Resource<S> {
        /// Create new resource with specified resource definition
        pub fn new(rdef: ResourceDef) -> Self {
            Resource {
                rdef,
                routes: SmallVec::new(),
                middlewares: Rc::new(Vec::new()),
            }
        }

        /// Name of the resource
        pub(crate) fn get_name(&self) -> &str {
            self.rdef.name()
        }

        /// Set resource name
        pub fn name(&mut self, name: &str) {
            self.rdef.set_name(name);
        }

        /// Resource definition
        pub fn rdef(&self) -> &ResourceDef {
            &self.rdef
        }
    }

    impl<S: 'static> Resource<S> {
        /// Register a new route and return mutable reference to *Route* object.
        /// *Route* is used for route configuration, i.e. adding predicates,
        /// setting up handler.
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// use actix_web::*;
        ///
        /// fn main() {
        ///     let app = App::new()
        ///         .resource("/", |r| {
        ///             r.route()
        ///                 .filter(pred::Any(pred::Get()).or(pred::Put()))
        ///                 .filter(pred::Header("Content-Type", "text/plain"))
        ///                 .f(|r| HttpResponse::Ok())
        ///         })
        ///         .finish();
        /// }
        /// ```
        pub fn route(&mut self) -> &mut Route<S> {
            self.routes.push(Route::default());
            self.routes.last_mut().unwrap()
        }

        /// Register a new `GET` route.
        pub fn get(&mut self) -> &mut Route<S> {
            self.routes.push(Route::default());
            self.routes.last_mut().unwrap().filter(pred::Get())
        }

        /// Register a new `POST` route.
        pub fn post(&mut self) -> &mut Route<S> {
            self.routes.push(Route::default());
            self.routes.last_mut().unwrap().filter(pred::Post())
        }

        /// Register a new `PUT` route.
        pub fn put(&mut self) -> &mut Route<S> {
            self.routes.push(Route::default());
            self.routes.last_mut().unwrap().filter(pred::Put())
        }

        /// Register a new `DELETE` route.
        pub fn delete(&mut self) -> &mut Route<S> {
            self.routes.push(Route::default());
            self.routes.last_mut().unwrap().filter(pred::Delete())
        }

        /// Register a new `HEAD` route.
        pub fn head(&mut self) -> &mut Route<S> {
            self.routes.push(Route::default());
            self.routes.last_mut().unwrap().filter(pred::Head())
        }

        /// Register a new route and add method check to route.
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// use actix_web::*;
        /// fn index(req: &HttpRequest) -> HttpResponse { unimplemented!() }
        ///
        /// App::new().resource("/", |r| r.method(http::Method::GET).f(index));
        /// ```
        ///
        /// This is shortcut for:
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// # use actix_web::*;
        /// # fn index(req: &HttpRequest) -> HttpResponse { unimplemented!() }
        /// App::new().resource("/", |r| r.route().filter(pred::Get()).f(index));
        /// ```
        pub fn method(&mut self, method: Method) -> &mut Route<S> {
            self.routes.push(Route::default());
            self.routes.last_mut().unwrap().filter(pred::Method(method))
        }

        /// Register a new route and add handler object.
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// use actix_web::*;
        /// fn handler(req: &HttpRequest) -> HttpResponse { unimplemented!() }
        ///
        /// App::new().resource("/", |r| r.h(handler));
        /// ```
        ///
        /// This is shortcut for:
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// # use actix_web::*;
        /// # fn handler(req: &HttpRequest) -> HttpResponse { unimplemented!() }
        /// App::new().resource("/", |r| r.route().h(handler));
        /// ```
        pub fn h<H: Handler<S>>(&mut self, handler: H) {
            self.routes.push(Route::default());
            self.routes.last_mut().unwrap().h(handler)
        }

        /// Register a new route and add handler function.
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// use actix_web::*;
        /// fn index(req: &HttpRequest) -> HttpResponse { unimplemented!() }
        ///
        /// App::new().resource("/", |r| r.f(index));
        /// ```
        ///
        /// This is shortcut for:
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// # use actix_web::*;
        /// # fn index(req: &HttpRequest) -> HttpResponse { unimplemented!() }
        /// App::new().resource("/", |r| r.route().f(index));
        /// ```
        pub fn f<F, R>(&mut self, handler: F)
        where
            F: Fn(&HttpRequest<S>) -> R + 'static,
            R: Responder + 'static,
        {
            self.routes.push(Route::default());
            self.routes.last_mut().unwrap().f(handler)
        }

        /// Register a new route and add handler.
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// use actix_web::*;
        /// fn index(req: HttpRequest) -> HttpResponse { unimplemented!() }
        ///
        /// App::new().resource("/", |r| r.with(index));
        /// ```
        ///
        /// This is shortcut for:
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// # use actix_web::*;
        /// # fn index(req: HttpRequest) -> HttpResponse { unimplemented!() }
        /// App::new().resource("/", |r| r.route().with(index));
        /// ```
        pub fn with<T, F, R>(&mut self, handler: F)
        where
            F: Fn(T) -> R + 'static,
            R: Responder + 'static,
            T: FromRequest<S> + 'static,
        {
            self.routes.push(Route::default());
            self.routes.last_mut().unwrap().with(handler);
        }

        /// Register a new route and add async handler.
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// # extern crate futures;
        /// use actix_web::*;
        /// use futures::future::Future;
        ///
        /// fn index(req: HttpRequest) -> Box<Future<Item=HttpResponse, Error=Error>> {
        ///     unimplemented!()
        /// }
        ///
        /// App::new().resource("/", |r| r.with_async(index));
        /// ```
        ///
        /// This is shortcut for:
        ///
        /// ```rust
        /// # extern crate actix_web;
        /// # extern crate futures;
        /// # use actix_web::*;
        /// # use futures::future::Future;
        /// # fn index(req: HttpRequest) -> Box<Future<Item=HttpResponse, Error=Error>> {
        /// #     unimplemented!()
        /// # }
        /// App::new().resource("/", |r| r.route().with_async(index));
        /// ```
        pub fn with_async<T, F, R, I, E>(&mut self, handler: F)
        where
            F: Fn(T) -> R + 'static,
            R: Future<Item = I, Error = E> + 'static,
            I: Responder + 'static,
            E: Into<Error> + 'static,
            T: FromRequest<S> + 'static,
        {
            self.routes.push(Route::default());
            self.routes.last_mut().unwrap().with_async(handler);
        }

        /// Register a resource middleware
        ///
        /// This is similar to `App's` middlewares, but
        /// middlewares get invoked on resource level.
        ///
        /// *Note* `Middleware::finish()` fires right after response get
        /// prepared. It does not wait until body get sent to peer.
        pub fn middleware<M: Middleware<S>>(&mut self, mw: M) {
            Rc::get_mut(&mut self.middlewares)
                .unwrap()
                .push(Box::new(mw));
        }

        #[inline]
        pub(crate) fn get_route_id(&self, req: &HttpRequest<S>) -> Option<RouteId> {
            for idx in 0..self.routes.len() {
                if (&self.routes[idx]).check(req) {
                    return Some(RouteId(idx));
                }
            }
            None
        }

        #[inline]
        pub(crate) fn handle(
            &self, id: RouteId, req: &HttpRequest<S>,
        ) -> AsyncResult<HttpResponse> {
            if self.middlewares.is_empty() {
                (&self.routes[id.0]).handle(req)
            } else {
                (&self.routes[id.0]).compose(req.clone(), Rc::clone(&self.middlewares))
            }
        }
    }

    /// Default resource
    pub struct DefaultResource<S>(Rc<Resource<S>>);

    impl<S> Deref for DefaultResource<S> {
        type Target = Resource<S>;

        fn deref(&self) -> &Resource<S> {
            self.0.as_ref()
        }
    }

    impl<S> Clone for DefaultResource<S> {
        fn clone(&self) -> Self {
            DefaultResource(self.0.clone())
        }
    }

    impl<S> From<Resource<S>> for DefaultResource<S> {
        fn from(res: Resource<S>) -> Self {
            DefaultResource(Rc::new(res))
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)