Struct azure_functions::http::ResponseBuilder

pub struct ResponseBuilder(_);

Represents a builder for HTTP responses.

Methods

impl ResponseBuilder

pub fn new() -> ResponseBuilder

Creates a new ResponseBuilder.

pub fn status<S: Into<Status>>(self, status: S) -> Self

Sets the status for the response.

Examples

use azure_functions::http::Status;

let response = ResponseBuilder::new()
    .status(Status::InternalServerError)
    .finish();

assert_eq!(response.status(), Status::InternalServerError);

pub fn header<T: Into<String>, U: Into<String>>(self, name: T, value: U) -> Self

Sets a header for the response.

Examples

let value = "custom header value";

let response = ResponseBuilder::new()
    .header("X-Custom-Header", value)
    .finish();

assert_eq!(
    response
        .headers()
        .get("X-Custom-Header")
        .unwrap(),
    value
);

pub fn body<'a, B>(self, body: B) -> Self where
    B: Into<Body<'a>>, 

Sets the body of the response.

This will automatically set a Content-Type header for the response depending on the body type.

Examples

use azure_functions::http::{Body, Status};

let message = "The resouce was created.";

let response = ResponseBuilder::new()
    .status(Status::Created)
    .body(message)
    .finish();

assert_eq!(response.status(), Status::Created);
assert_eq!(
    response.body().as_str().unwrap(),
    message
);

pub fn finish(self) -> HttpResponse

Consumes the builder and returns the HTTP response.

Trait Implementations

impl Default for ResponseBuilder

fn default() -> ResponseBuilder

Returns the "default value" for a type.

impl Debug for ResponseBuilder

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.