Struct snowboard::Request

pub struct Request {
    pub ip: SocketAddr,
    pub url: String,
    pub method: Method,
    pub body: Vec<u8>,
    pub headers: HashMap<String, String>,
}

A server request. Parses the raw request string into a more usable format.

Fields

ip: SocketAddr

The ip from the socket connection.

url: String

Raw URL string. Use Request::parse_url() to get a parsed version of the URL

method: Method

Method used in the request. Might be Method::Unknown if parsing fails.

body: Vec<u8>

Body of the request, in bytes. Use Request::text, [Request::json], or [Request::force_json] to get a parsed version of the body.

headers: HashMap<String, String>

Parsed headers.

Implementations

impl Request

pub fn new(bytes: &[u8], ip: SocketAddr) -> Option<Self>

Parses and creates a requeset from raw text and an ip address. Note that this does not parse the url (See Request::url).

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

Safely gets a header.

pub fn get_header_or(&self, key: &str, default: &'static str) -> &str

Equivalent to get_header(key).unwrap_or(default)

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

Checks if a header exists.

pub fn set_header<T: ToString, K: ToString>(&mut self, k: T, v: K)

Sets a header using any key and value convertible to Strings

pub fn len(&self) -> usize

Gets the length of the body.

pub fn is_empty(&self) -> bool

Checks if the body is empty.

pub fn text(&self) -> Cow<'_, str>

Gets the body as a string. See String::from_utf8_lossy

pub fn parse_url(&self) -> Url<'_>

Get a parsed version of the URL. See Url

pub fn pretty_ip(&self) -> String

Get the IP address of the client, formatted.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl PartialEq for Request

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Request

impl StructuralEq for Request

impl StructuralPartialEq for Request