[][src]Struct actix_web::web::Payload

pub struct Payload(pub Payload);

Payload extractor returns request 's payload stream.

Example

use futures::{Future, Stream};
use actix_web::{web, error, App, Error, HttpResponse};

/// extract binary data from request
fn index(body: web::Payload) -> impl Future<Item = HttpResponse, Error = Error>
{
    body.map_err(Error::from)
        .fold(web::BytesMut::new(), move |mut body, chunk| {
            body.extend_from_slice(&chunk);
            Ok::<_, Error>(body)
         })
         .and_then(|body| {
             format!("Body {:?}!", body);
             Ok(HttpResponse::Ok().finish())
         })
}

fn main() {
    let app = App::new().service(
        web::resource("/index.html").route(
            web::get().to_async(index))
    );
}

Methods

impl Payload[src]

pub fn into_inner(self) -> Payload[src]

Deconstruct to a inner value

Trait Implementations

impl FromRequest for Payload[src]

Get request's payload stream

Example

use futures::{Future, Stream};
use actix_web::{web, error, App, Error, HttpResponse};

/// extract binary data from request
fn index(body: web::Payload) -> impl Future<Item = HttpResponse, Error = Error>
{
    body.map_err(Error::from)
        .fold(web::BytesMut::new(), move |mut body, chunk| {
            body.extend_from_slice(&chunk);
            Ok::<_, Error>(body)
         })
         .and_then(|body| {
             format!("Body {:?}!", body);
             Ok(HttpResponse::Ok().finish())
         })
}

fn main() {
    let app = App::new().service(
        web::resource("/index.html").route(
            web::get().to_async(index))
    );
}

type Config = PayloadConfig

Configuration for this extractor

type Error = Error

The associated error which can be returned.

type Future = Result<Payload, Error>

Future that resolves to a Self

fn extract(req: &HttpRequest) -> Self::Future[src]

Convert request to a Self Read more

fn configure<F>(f: F) -> Self::Config where
    F: FnOnce(Self::Config) -> Self::Config
[src]

Create and configure config instance.

impl Stream for Payload[src]

type Item = Bytes

The type of item this stream will yield on success.

type Error = PayloadError

The type of error this stream may generate.

fn wait(self) -> Wait<Self>[src]

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

fn into_future(self) -> StreamFuture<Self>[src]

Converts this stream into a Future. Read more

fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> U, 
[src]

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

fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> U, 
[src]

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

fn filter<F>(self, f: F) -> Filter<Self, F> where
    F: FnMut(&Self::Item) -> bool
[src]

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

fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 
[src]

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

fn then<F, U>(self, f: F) -> Then<Self, F, U> where
    F: FnMut(Result<Self::Item, Self::Error>) -> U,
    U: IntoFuture
[src]

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

fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Error = Self::Error>, 
[src]

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

fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
    F: FnMut(Self::Error) -> U,
    U: IntoFuture<Item = Self::Item>, 
[src]

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

fn collect(self) -> Collect<Self>[src]

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

fn concat2(self) -> Concat2<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator,
    Self::Item: Default
[src]

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

fn concat(self) -> Concat<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator
[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

fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: IntoFuture<Item = T>,
    Self::Error: From<<Fut as IntoFuture>::Error>, 
[src]

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

fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error: From<Self::Error>, 
[src]

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

fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>, 
[src]

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

fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>, 
[src]

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

fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Item = (), Error = Self::Error>, 
[src]

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

fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 
[src]

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

fn take(self, amt: u64) -> Take<Self>[src]

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

fn skip(self, amt: u64) -> Skip<Self>[src]

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

fn fuse(self) -> Fuse<Self>[src]

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

fn by_ref(&mut self) -> &mut Self[src]

Borrows a stream, rather than consuming it. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe
[src]

Catches unwinding panics while polling the stream. Read more

fn buffered(self, amt: usize) -> Buffered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error
[src]

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

fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error
[src]

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

fn merge<S>(self, other: S) -> Merge<Self, S> where
    S: Stream<Error = Self::Error>, 
[src]

Deprecated:

functionality provided by select now

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

fn zip<S>(self, other: S) -> Zip<Self, S> where
    S: Stream<Error = Self::Error>, 
[src]

An adapter for zipping two streams together. Read more

fn chain<S>(self, other: S) -> Chain<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, 
[src]

Adapter for chaining two stream. Read more

fn peekable(self) -> Peekable<Self>[src]

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

fn chunks(self, capacity: usize) -> Chunks<Self>[src]

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

fn select<S>(self, other: S) -> Select<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, 
[src]

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

fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink<SinkItem = Self::Item>,
    Self::Error: From<<S as Sink>::SinkError>, 
[src]

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

fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
    Self: Sink
[src]

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

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 
[src]

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

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnMut(&Self::Error), 
[src]

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

Auto Trait Implementations

impl Unpin for Payload

impl !Sync for Payload

impl !Send for Payload

impl !UnwindSafe for Payload

impl !RefUnwindSafe for Payload

Blanket Implementations

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> IntoStream for T where
    T: Stream

type Item = <T as Stream>::Item

type Error = <T as Stream>::Error

type Stream = T

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,