[]Struct paperclip::actix::web::Payload

pub struct Payload(pub Payload<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static>>>);

Payload extractor returns request 's payload stream.

Example

use futures::{Future, Stream, StreamExt};
use actix_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<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static>>>

Deconstruct to a inner value

Trait Implementations

impl Apiv2Schema for Payload[src]

impl FromRequest for Payload

Get request's payload stream

Example

use futures::{Future, Stream, StreamExt};
use actix_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

impl OperationModifier for Payload[src]

impl Stream for Payload

type Item = Result<Bytes, PayloadError>

Values yielded by the stream.

Auto Trait Implementations

impl !RefUnwindSafe for Payload

impl !Send for Payload

impl !Sync for Payload

impl Unpin for Payload

impl !UnwindSafe for Payload

Blanket Implementations

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

impl<T> Apiv2Schema for T where
    T: TypedData
[src]

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

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

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

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

impl<T> StreamExt for T where
    T: Stream + ?Sized
[src]

impl<St> StreamExt for St where
    St: Stream + ?Sized
[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, U> TryInto<U> for T where
    U: TryFrom<T>, 

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

impl<S, T, E> TryStream for S where
    S: Stream<Item = Result<T, E>> + ?Sized
[src]

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

impl<S> TryStreamExt for S where
    S: TryStream + ?Sized
[src]

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