Struct sharp_pencil::wrappers::Request

pub struct Request<'r, 'a, 'b: 'a> {
    pub app: &'r Pencil,
    pub remote_addr: SocketAddr,
    pub method: Method,
    pub headers: Headers,
    pub url: Url,
    pub url_rule: Option<Rule>,
    pub view_args: ViewArgs,
    pub routing_redirect: Option<(String, u16)>,
    pub routing_error: Option<HTTPError>,
    pub extensions_data: TypeMap,
    pub host: Host,
    /* private fields */
}

Request type.

Fields

app: &'r Pencil

remote_addr: SocketAddr

The IP address of the remote connection.

method: Method

The request method.

headers: Headers

The headers of the incoming request.

url: Url

The requested url.

url_rule: Option<Rule>

The URL rule that matched the request. This is going to be None if nothing matched.

view_args: ViewArgs

A dict of view arguments that matched the request.

routing_redirect: Option<(String, u16)>

If matching the URL requests a redirect, this will be the redirect.

routing_error: Option<HTTPError>

If matching the URL failed, this will be the routing error.

extensions_data: TypeMap

Storage for data of extensions.

host: Host

The server host

Implementations

impl<'r, 'a, 'b: 'a> Request<'r, 'a, 'b>

pub fn new(
    app: &'r Pencil,
    http_request: HttpRequest<'a, 'b>
) -> Result<Request<'r, 'a, 'b>, String>

Create a Request.

pub fn url_adapter(&self) -> MapAdapter<'_>

Get the url adapter for this request.

pub fn match_request(&mut self)

Match the request, set the url_rule and view_args field.

pub fn endpoint(&self) -> Option<String>

The endpoint that matched the request.

pub fn module_name(&self) -> Option<String>

The current module name.

pub fn args(&self) -> &MultiDict<String>

The parsed URL parameters.

pub fn get_json(&self) -> &Option<Value>

Parses the incoming JSON request data.

pub fn form(&self) -> &MultiDict<String>

The form parameters.

pub fn files(&self) -> &MultiDict<FilePart>

All uploaded files.

pub fn headers(&self) -> &Headers

The headers.

pub fn path(&self) -> String

Requested path.

pub fn full_path(&self) -> String

Requested path including the query string.

pub fn host(&self) -> String

The host including the port if available.

pub fn query_string(&self) -> Option<String>

The query string.

pub fn cookies(&self) -> Option<&Cookie>

The retrieved cookies.

pub fn method(&self) -> Method

The request method.

pub fn remote_addr(&self) -> SocketAddr

The remote address of the client.

pub fn scheme(&self) -> String

URL scheme (http or https)

pub fn host_url(&self) -> String

Just the host with scheme.

pub fn url(&self) -> String

The current url.

pub fn base_url(&self) -> String

The current url without the query string.

pub fn is_secure(&self) -> bool

Whether the request is secure (https).

Trait Implementations

impl<'r, 'a, 'b: 'a> Debug for Request<'r, 'a, 'b>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'r, 'a, 'b: 'a> Read for Request<'r, 'a, 'b>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adapter which will read at most limit bytes from it.