Struct actix_web::HttpRequest [] [src]

pub struct HttpRequest<S = ()>(_, _, _);

An HTTP Request

Methods

impl HttpRequest<()>
[src]

Important traits for HttpRequest<S>
[src]

Construct a new Request.

Important traits for HttpRequest<S>
[src]

Construct new http request with state.

impl<S> HttpRequest<S>
[src]

Important traits for HttpRequest<S>
[src]

Construct new http request with state.

Important traits for &'a mut W
[src]

Shared application state

[src]

Request extensions

[src]

Read the Request Uri.

[src]

Read the Request method.

[src]

Read the Request Version.

[src]

The target path of this Request.

[src]

Get ConnectionInfo for correct request.

[src]

Generate url for named resource

fn index(req: HttpRequest) -> HttpResponse {
    let url = req.url_for("foo", &["1", "2", "3"]); // <- generate url for "foo" resource
    HttpOk.into()
}

fn main() {
    let app = Application::new()
        .resource("/test/{one}/{two}/{three}", |r| {
             r.name("foo");  // <- set resource name, then it could be used in `url_for`
             r.method(Method::GET).f(|_| httpcodes::HttpOk);
        })
        .finish();
}

[src]

This method returns reference to current Router object.

[src]

Peer socket address

Peer address is actual socket address, if proxy is used in front of actix http server, then peer address would be address of this proxy.

To get client connection information connection_info() method should be used.

[src]

Get a reference to the Params object. Params is a container for url query parameters.

[src]

The query string in the URL.

E.g., id=10

[src]

Load request cookies.

[src]

Return request cookie.

[src]

Get a reference to the Params object. Params is a container for url parameters. Route supports glob patterns: * for a single wildcard segment and :param for matching storing that segment of the request url in the Params object.

[src]

Get mutable reference to request's Params.

[src]

Checks if a connection should be kept alive.

[src]

Set read buffer capacity

Default buffer capacity is 32Kb.

Trait Implementations

impl<S> HttpMessage for HttpRequest<S>
[src]

[src]

Read the message headers.

[src]

Read the request content type. If request does not contain Content-Type header, empty str get returned. Read more

[src]

Get content type encoding Read more

[src]

Convert the request content type to a known mime type.

[src]

Check if request has chunked transfer encoding

[src]

Parses Range HTTP header string as per RFC 2616. size is full size of response (file). Read more

[src]

Load http message body. Read more

[src]

Parse application/x-www-form-urlencoded encoded body. Return UrlEncoded future. It resolves to a HashMap<String, String> which contains decoded parameters. Read more

[src]

Parse application/json encoded body. Return JsonBody<T> future. It resolves to a T value. Read more

[src]

Return stream to http payload processes as multipart. Read more

impl Default for HttpRequest<()>
[src]

Important traits for HttpRequest<S>
[src]

Construct default request

impl<S> Clone for HttpRequest<S>
[src]

Important traits for HttpRequest<S>
[src]

Returns a copy of the value. Read more

1.0.0
[src]

Performs copy-assignment from source. Read more

impl<S> Stream for HttpRequest<S>
[src]

The type of item this stream will yield on success.

The type of error this stream may generate.

[src]

Attempt to pull out the next value of this stream, returning None if the stream is finished. Read more

Important traits for Wait<S>
[src]

Creates an iterator which blocks the current thread until each item of this stream is resolved. Read more

[src]

Converts this stream into a Future. Read more

[src]

Converts a stream of type T to a stream of type U. Read more

[src]

Converts a stream of error type T to a stream of error type U. Read more

[src]

Filters the values produced by this stream according to the provided predicate. Read more

[src]

Filters the values produced by this stream while simultaneously mapping them to a different type. Read more

[src]

Chain on a computation for when a value is ready, passing the resulting item to the provided closure f. Read more

[src]

Chain on a computation for when a value is ready, passing the successful results to the provided closure f. Read more

[src]

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f. Read more

[src]

Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more

[src]

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more

[src]

Deprecated since 0.1.14

: please use Stream::concat2 instead

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more

[src]

Execute an accumulating computation over a stream, collecting all the values into one final result. Read more

[src]

Flattens a stream of streams into just one continuous stream. Read more

[src]

Skip elements on this stream while the predicate provided resolves to true. Read more

[src]

Take elements from this stream while the predicate provided resolves to true. Read more

[src]

Runs this stream to completion, executing the provided closure for each element on the stream. Read more

[src]

Map this stream's error to any error implementing From for this stream's Error, returning a new stream. Read more

[src]

Creates a new stream of at most amt items of the underlying stream. Read more

[src]

Creates a new stream which skips amt items of the underlying stream. Read more

[src]

Fuse a stream such that poll will never again be called once it has finished. Read more

Important traits for &'a mut W
[src]

Borrows a stream, rather than consuming it. Read more

[src]

Catches unwinding panics while polling the stream. Read more

[src]

An adaptor for creating a buffered list of pending futures. Read more

[src]

An adaptor for creating a buffered list of pending futures (unordered). Read more

[src]

Deprecated

: functionality provided by select now

An adapter for merging the output of two streams. Read more

[src]

An adapter for zipping two streams together. Read more

[src]

Adapter for chaining two stream. Read more

[src]

Creates a new stream which exposes a peek method. Read more

[src]

An adaptor for chunking up items of the stream inside a vector. Read more

[src]

Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. Read more

[src]

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

[src]

Splits this Stream + Sink object into separate Stream and Sink objects. Read more

[src]

Do something with each item of this stream, afterwards passing it on. Read more

[src]

Do something with the error of this stream, afterwards passing it on. Read more

impl<S> Read for HttpRequest<S>
[src]

[src]

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

[src]

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

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

1.0.0
[src]

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

1.0.0
[src]

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

1.6.0
[src]

Read the exact number of bytes required to fill buf. Read more

Important traits for &'a mut W
1.0.0
[src]

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

Important traits for Bytes<R>
1.0.0
[src]

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

Important traits for Chars<R>
[src]

🔬 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. Read more

Important traits for Chain<T, U>
1.0.0
[src]

Creates an adaptor which will chain this stream with another. Read more

Important traits for Take<T>
1.0.0
[src]

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

impl<S> AsyncRead for HttpRequest<S>
[src]

[src]

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out. Read more

[src]

Attempt to read from the AsyncRead into buf. Read more

[src]

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

[src]

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data. Read more

[src]

Helper method for splitting this read/write object into two halves. Read more

impl<S> Debug for HttpRequest<S>
[src]

[src]

Formats the value using the given formatter. Read more

impl<S> RequestSession for HttpRequest<S>
[src]

[src]

Auto Trait Implementations

impl<S = ()> !Send for HttpRequest<S>

impl<S = ()> !Sync for HttpRequest<S>