Struct hyper::server::request::Request

pub struct Request<'a, 'b: 'a> {
    pub remote_addr: SocketAddr,
    pub method: Method,
    pub headers: Headers,
    pub uri: RequestUri,
    pub version: HttpVersion,
    // some fields omitted
}

A request bundles several parts of an incoming NetworkStream, given to a Handler.

Fields

remote_addr: SocketAddr

The IP address of the remote connection.

method: Method

The Method, such as Get, Post, etc.

headers: Headers

The headers of the incoming request.

uri: RequestUri

The target request-uri for this request.

version: HttpVersion

The version of HTTP for this request.

Methods

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

pub fn new(
    stream: &'a mut BufReader<&'b mut NetworkStream>,
    addr: SocketAddr
) -> Result<Request<'a, 'b>>

Create a new Request, reading the StartLine and Headers so they are immediately useful.

pub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<()>

Set the read timeout of the underlying NetworkStream.

pub fn downcast_ref<T: NetworkStream>(&self) -> Option<&T>

Get a reference to the underlying NetworkStream.

pub fn ssl<T: NetworkStream>(&self) -> Option<&T>

Get a reference to the underlying Ssl stream, if connected over HTTPS.

This is actually just an alias for downcast_ref.

pub fn deconstruct(
    self
) -> (SocketAddr, Method, Headers, RequestUri, HttpVersion, HttpReader<&'a mut BufReader<&'b mut NetworkStream>>)

Deconstruct a Request into its constituent parts.

Trait Implementations

impl<'a, 'b> Read for Request<'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.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> 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.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Creates a "by reference" adaptor for this instance of Read.

Important traits for Bytes<R>

impl<R> Iterator for Bytes<R> where
    R: Read,  type Item = Result<u8, Error>;

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

Important traits for Chars<R>

impl<R> Iterator for Chars<R> where
    R: Read,  type Item = Result<char, CharsError>;

fn chars(self) -> Chars<Self>

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s.

Important traits for Chain<T, U>

impl<T, U> Read for Chain<T, U> where
    T: Read,
    U: Read, 

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

Creates an adaptor which will chain this stream with another.

Important traits for Take<T>

impl<T> Read for Take<T> where
    T: Read, 

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

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