Struct hyper::server::request::Request

[+] Show declaration

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
}

[−] Expand description

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

Fields

remote_addr: SocketAddr

[−] Expand description

The IP address of the remote connection.

method: Method

[−] Expand description

The Method, such as Get, Post, etc.

headers: Headers

[−] Expand description

The headers of the incoming request.

uri: RequestUri

[−] Expand description

The target request-uri for this request.

version: HttpVersion

[−] Expand description

The version of HTTP for this request.

Methods

impl<'a, 'b: 'a> Request<'a, 'b>[−]

pub fn new(
    stream: &'a mut BufReader<&'b mut dyn 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 dyn NetworkStream>>)[−]

Deconstruct a Request into its constituent parts.

Trait Implementations

impl<'a, 'b> Read for Request<'a, 'b>[+]

[+] Show hidden undocumented items

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.

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.

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 adaptor which will chain this stream with another.

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

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