Struct ResponseOutparam

pub struct ResponseOutparam(/* private fields */);

A parameter provided by Spin for setting a streaming OutgoingResponse.

Examples

Send a streaming response to an incoming request:

async fn handle_request(req: IncomingRequest, response_outparam: ResponseOutparam) {
    use futures::SinkExt;
    use std::io::Read;

    let response_headers = Fields::from_list(&[
        ("content-type".to_owned(), "text/plain".into())
    ]).unwrap();

    let response = OutgoingResponse::new(response_headers);
    response.set_status_code(200).unwrap();
    let mut response_body = response.take_body();

    response_outparam.set(response);

    let mut file = std::fs::File::open("war-and-peace.txt").unwrap();

    loop {
        let mut buf = vec![0; 1024];
        let count = file.read(&mut buf).unwrap();

        if count == 0 {
            break;  // end of file
        }

        buf.truncate(count);
        response_body.send(buf).await.unwrap();
    }
}

Implementations

impl ResponseOutparam

pub fn set(self, response: OutgoingResponse)

Set the outgoing response

pub async fn set_with_body( self, response: OutgoingResponse, buffer: Vec<u8>, ) -> Result<(), StreamError>

Set with the outgoing response and the supplied buffer

Will panic if response body has already been taken

pub fn into_inner(self) -> ResponseOutparam

Return the inner, wit-bindgen-generated instance