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>>(&mut self, status: S) -> &mut Self

Sets the status for the response.

Examples

use azure_functions::bindings::HttpResponse;
use azure_functions::http::Status;

let response: HttpResponse = HttpResponse::build()
    .status(Status::InternalServerError)
    .into();

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

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

Sets a header for the response.

Examples

use azure_functions::bindings::HttpResponse;

let value = "custom header value";

let response: HttpResponse = HttpResponse::build()
    .header("X-Custom-Header", value)
    .into();

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

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

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::bindings::HttpResponse;
use azure_functions::http::{Body, Status};

let message = "The resouce was created.";

let response: HttpResponse = HttpResponse::build()
    .status(Status::Created)
    .body(message)
    .into();

assert_eq!(response.status(), Status::Created);
assert_eq!(
    match response.body() {
        Body::String(s) => s,
        _ => panic!("unexpected body.")
    },
    message
);

Trait Implementations

impl<'a> From<&'a mut ResponseBuilder> for HttpResponse

fn from(builder: &'a mut ResponseBuilder) -> Self

Performs the conversion.

impl Debug for ResponseBuilder

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

Formats the value using the given formatter.