Struct requiem_web::web::Payload

pub struct Payload(pub Payload);

Payload extractor returns request 's payload stream.

Example

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

/// extract binary data from request
async fn index(mut body: web::Payload) -> Result<HttpResponse, Error>
{
    let mut bytes = web::BytesMut::new();
    while let Some(item) = body.next().await {
        bytes.extend_from_slice(&item?);
    }

    format!("Body {:?}!", bytes);
    Ok(HttpResponse::Ok().finish())
}

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

Methods

impl Payload

pub fn into_inner(self) -> Payload

Deconstruct to a inner value

Trait Implementations

impl FromRequest for Payload

Get request's payload stream

Example

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

/// extract binary data from request
async fn index(mut body: web::Payload) -> Result<HttpResponse, Error>
{
    let mut bytes = web::BytesMut::new();
    while let Some(item) = body.next().await {
        bytes.extend_from_slice(&item?);
    }

    format!("Body {:?}!", bytes);
    Ok(HttpResponse::Ok().finish())
}

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

type Config = PayloadConfig

Configuration for this extractor

type Error = Error

The associated error which can be returned.

type Future = Ready<Result<Payload, Error>>

Future that resolves to a Self

fn from_request(_: &HttpRequest, payload: &mut Payload) -> Self::Future

Convert request to a Self

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

Convert request to a Self

fn configure<F>(f: F) -> Self::Config where
    F: FnOnce(Self::Config) -> Self::Config, 

Create and configure config instance.

impl Stream for Payload

type Item = Result<Bytes, PayloadError>

Values yielded by the stream.

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.