Struct RequestBuilder

pub struct RequestBuilder { /* private fields */ }

A builder for non-streaming outgoing HTTP requests. You can obtain a RequestBuilder from the Request::builder() method, or from method-specific helpers such as Request::get() or Request::post().

Examples

Use a method helper to build an outgoing POST request:

use spin_sdk::http::{Request, Response};

let request = Request::post("https://example.com", "it's a-me, Spin")
    .header("content-type", "text/plain")
    .build();
let response: Response = spin_sdk::http::send(request).await?;

Build and send an outgoing request using the RequestBuilder.

use spin_sdk::http::{Method, Request, Response};

let request = Request::builder()
    .uri("https://example.com/message/motivational")
    .method(Method::Put)
    .header("content-type", "text/plain")
    .body("the capybaras of creativity fly higher than the bluebirds of banality")
    .build();
let response: Response = spin_sdk::http::send(request).await?;

Implementations

impl RequestBuilder

pub fn new(method: Method, uri: impl Into<String>) -> Self

Create a new RequestBuilder

pub fn method(&mut self, method: Method) -> &mut Self

Set the method

pub fn uri(&mut self, uri: impl Into<String>) -> &mut Self

Set the uri

pub fn headers(&mut self, headers: impl IntoHeaders) -> &mut Self

Set the headers

pub fn header( &mut self, key: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Set a header

pub fn body(&mut self, body: impl IntoBody) -> &mut Self

Set the body

pub fn build(&mut self) -> Request

Build the Request

Trait Implementations

impl TryIntoOutgoingRequest for RequestBuilder

type Error = Error

The error if the conversion fails

fn try_into_outgoing_request( self, ) -> Result<(OutgoingRequest, Option<Vec<u8>>), Self::Error>

Turn the type into an OutgoingRequest