Struct nickel::Request

pub struct Request<'mw, 'server: 'mw, D: 'mw = ()> {
    pub origin: HyperRequest<'mw, 'server>,
    pub route_result: Option<RouteResult<'mw, D>>,
    // some fields omitted
}

A container for all the request data.

The lifetime 'mw represents the lifetime of various bits of middleware state within nickel. It can vary and get shorter.

The lifetime 'server represents the lifetime of data internal to the server. It is fixed and longer than 'mw.

Fields

origin: HyperRequest<'mw, 'server>

the original hyper::server::Request

route_result: Option<RouteResult<'mw, D>>

a HashMap<String, String> holding all params with names and values

Methods

impl<'mw, 'server, D> Request<'mw, 'server, D>

fn from_internal(
    req: HyperRequest<'mw, 'server>,
    data: &'mw D
) -> Request<'mw, 'server, D>

fn param(&self, key: &str) -> Option<&str>

fn path_without_query(&self) -> Option<&str>

fn server_data(&self) -> &'mw D

Trait Implementations

impl<'mw, 'server, D> Extensible for Request<'mw, 'server, D>

fn extensions(&self) -> &TypeMap

Get a reference to the type's extension storage.

fn extensions_mut(&mut self) -> &mut TypeMap

Get a mutable reference to the type's extension storage.

impl<'mw, 'server, D> Pluggable for Request<'mw, 'server, D>

fn get<P>(&mut self) -> Result<<P as Key>::Value, <P as Plugin<Self>>::Error> where
    P: Plugin<Self>,
    Self: Extensible,
    <P as Key>::Value: Clone,
    <P as Key>::Value: Any, 

Return a copy of the plugin's produced value.

fn get_ref<P>(
    &mut self
) -> Result<&<P as Key>::Value, <P as Plugin<Self>>::Error> where
    P: Plugin<Self>,
    Self: Extensible,
    <P as Key>::Value: Any, 

Return a reference to the plugin's produced value.

fn get_mut<P>(
    &mut self
) -> Result<&mut <P as Key>::Value, <P as Plugin<Self>>::Error> where
    P: Plugin<Self>,
    Self: Extensible,
    <P as Key>::Value: Any, 

Return a mutable reference to the plugin's produced value.

fn compute<P>(
    &mut self
) -> Result<<P as Key>::Value, <P as Plugin<Self>>::Error> where
    P: Plugin<Self>, 

Create and evaluate a once-off instance of a plugin.

impl<'mw, 'conn, D> FormBody for Request<'mw, 'conn, D>

fn form_body(&mut self) -> Result<&Params, (StatusCode, BodyError)>

Extracts URL encoded data from the request body. # Examples ```{rust} #[macro_use] extern crate nickel; use nickel::{Nickel, HttpRouter, FormBody};

impl<'mw, 'conn, D> JsonBody for Request<'mw, 'conn, D>

fn json_as<T: Decodable>(&mut self) -> Result<T, Error>

impl<'mw, 'conn, D> QueryString for Request<'mw, 'conn, D>

fn query(&mut self) -> &Query

Extracts URL encoded data from the URL query string. # Examples ```{rust} #[macro_use] extern crate nickel; use nickel::{Nickel, HttpRouter, QueryString};

impl<'mw, 'server, D> Referer for Request<'mw, 'server, D>

fn referer(&self) -> Option<&str>

Get the Request's referer header

Examples

extern crate nickel;

use nickel::{Nickel, HttpRouter, Request, Response, MiddlewareResult};
use nickel::extensions::{Referer, Redirect};

fn referer<'mw, 'conn>(req: &mut Request<'mw, 'conn>, res: Response<'mw>) -> MiddlewareResult<'mw> {
    let back = req.referer().unwrap_or("http://nickel-org.github.io/");
    return res.redirect(back)
}

fn main() {
    let mut server = Nickel::new();
    server.get("/a", referer);
}