Struct actix_web::web::Payload

pub struct Payload(pub Payload);

Extract a request’s raw payload stream.

See PayloadConfig for important notes when using this advanced extractor.

Examples

use std::future::Future;
use futures_util::stream::StreamExt as _;
use actix_web::{post, web};

// `body: web::Payload` parameter extracts raw payload stream from request
#[post("/")]
async fn index(mut body: web::Payload) -> actix_web::Result<String> {
    // for demonstration only; in a normal case use the `Bytes` extractor
    // collect payload stream into a bytes object
    let mut bytes = web::BytesMut::new();
    while let Some(item) = body.next().await {
        bytes.extend_from_slice(&item?);
    }

    Ok(format!("Request Body Bytes:\n{:?}", bytes))
}

Implementations

impl Payload

pub fn into_inner(self) -> Payload

Unwrap to inner Payload type.

Trait Implementations

impl FromRequest for Payload

See here for example of usage as an extractor.

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

Create a Self from request parts asynchronously.

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

Create a Self from request head asynchronously.

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.

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

Returns the bounds on the remaining length of the stream.