Struct NickelRequest

pub struct NickelRequest<'mw, 'server, D = ()>
where
    'server: 'mw,
    D: 'mw,
{
    pub origin: Request<'mw, 'server>,
    pub route_result: Option<RouteResult<'mw, D>>,
    /* private fields */
}

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: Request<'mw, 'server>

the original hyper::server::Request

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

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

Implementations

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

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

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

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

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

Trait Implementations

impl<'r, 'mw: 'r, 'server: 'mw, D: 'mw> AsMut<&'r mut Request<'mw, 'server, D>> for Maybe<'r, 'mw, 'server, D>

fn as_mut(&mut self) -> &mut &'r mut NickelRequest<'mw, 'server, D>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'r, 'mw: 'r, 'server: 'mw, D: 'mw> AsRef<&'r mut Request<'mw, 'server, D>> for Maybe<'r, 'mw, 'server, D>

fn as_ref(&self) -> &&'r mut NickelRequest<'mw, 'server, D>

Converts this type into a shared reference of the (usually inferred) input type.

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, '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.

impl<'r, 'mw: 'r, 'server: 'mw, D: 'mw> From<&'r mut Request<'mw, 'server, D>> for Maybe<'r, 'mw, 'server, D>

fn from(req: &'r mut NickelRequest<'mw, 'server, D>) -> Self

Converts to this type from the input type.

impl<'r, 'mw: 'r, 'server: 'mw, D: 'mw> Into<&'r mut Request<'mw, 'server, D>> for Maybe<'r, 'mw, 'server, D>

fn into(self) -> &'r mut NickelRequest<'mw, 'server, D>

Converts this type into the (usually inferred) input type.

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

fn json_as<'a, T>(&'a mut self) -> Result<T, Error>

where T: Deserialize<'a>,

impl<'mw, 'server, D: 'mw> MultipartBody<'mw, 'server> for NickelRequest<'mw, 'server, D>

fn multipart_body( &mut self, ) -> Option<Multipart<&mut HyperRequest<'mw, 'server>>>

Get a multipart reader for the request body, if the request is of the right type.

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>, <P as Key>::Value: Clone + Any, Self: Extensible,

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>, <P as Key>::Value: Any, Self: Extensible,

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>, <P as Key>::Value: Any, Self: Extensible,

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> QueryString for Request<'mw, 'conn, D>

fn query(&mut self) -> &Params

Extracts URL encoded data from the URL query string.

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);
}