Struct WebmachineRequest

pub struct WebmachineRequest {
    pub request_path: String,
    pub base_path: String,
    pub path_vars: HashMap<String, String>,
    pub method: String,
    pub headers: HashMap<String, Vec<HeaderValue>>,
    pub body: Option<Bytes>,
    pub query: HashMap<String, Vec<String>>,
}

Request that the state machine is executing against

Fields

request_path: String

Path of the request relative to the resource

base_path: String

Resource base path

path_vars: HashMap<String, String>

Path parts mapped to any variables (i.e. parts like /{id} will have id mapped)

method: String

Request method

headers: HashMap<String, Vec<HeaderValue>>

Request headers

body: Option<Bytes>

Request body

query: HashMap<String, Vec<String>>

Query parameters

Implementations

impl WebmachineRequest

pub fn content_type(&self) -> HeaderValue

returns the content type of the request, based on the content type header. Defaults to ‘application/json’ if there is no header.

pub fn is_put_or_post(&self) -> bool

If the request is a put or post

pub fn is_get_or_head(&self) -> bool

If the request is a get or head request

pub fn is_get(&self) -> bool

If the request is a get

pub fn is_options(&self) -> bool

If the request is an options

pub fn is_put(&self) -> bool

If the request is a put

pub fn is_post(&self) -> bool

If the request is a post

pub fn is_delete(&self) -> bool

If the request is a delete

pub fn has_accept_header(&self) -> bool

If an Accept header exists

pub fn accept(&self) -> Vec<HeaderValue>

Returns the acceptable media types from the Accept header

pub fn has_accept_language_header(&self) -> bool

If an Accept-Language header exists

pub fn accept_language(&self) -> Vec<HeaderValue>

Returns the acceptable languages from the Accept-Language header

pub fn has_accept_charset_header(&self) -> bool

If an Accept-Charset header exists

pub fn accept_charset(&self) -> Vec<HeaderValue>

Returns the acceptable charsets from the Accept-Charset header

pub fn has_accept_encoding_header(&self) -> bool

If an Accept-Encoding header exists

pub fn accept_encoding(&self) -> Vec<HeaderValue>

Returns the acceptable encodings from the Accept-Encoding header

pub fn has_header(&self, header: &str) -> bool

If the request has the provided header

pub fn find_header(&self, header: &str) -> Vec<HeaderValue>

Returns the list of values for the provided request header. If the header is not present, or has no value, and empty vector is returned.

pub fn has_header_value(&self, header: &str, value: &str) -> bool

If the header has a matching value

Trait Implementations

impl Clone for WebmachineRequest

fn clone(&self) -> WebmachineRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebmachineRequest

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

Formats the value using the given formatter.

impl Default for WebmachineRequest

fn default() -> WebmachineRequest

Creates a default request (GET /)

impl PartialEq for WebmachineRequest

fn eq(&self, other: &WebmachineRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WebmachineRequest