Struct HttpResponse

Source

pub struct HttpResponse { /* private fields */ }

Expand description

Represents a HTTP output binding.

The following binding attributes are supported:

Name	Description
`name`	The name of the parameter being bound.

Responses can be created for any type that implements Into<Body>.

§Examples

Creating a response from a string:

use azure_functions::bindings::{HttpRequest, HttpResponse};
use azure_functions::func;

#[func]
pub fn example(_req: HttpRequest) -> HttpResponse {
    "Hello world!".into()
}

Creating a response from a JSON value (see the json! macro from the serde_json crate):

use azure_functions::bindings::{HttpRequest, HttpResponse};
use azure_functions::func;
use serde_json::json;

#[func]
pub fn example(_req: HttpRequest) -> HttpResponse {
    json!({ "hello": "world" }).into()
}

Creating a response from a sequence of bytes:

use azure_functions::bindings::{HttpRequest, HttpResponse};
use azure_functions::func;

#[func]
pub fn example(_req: HttpRequest) -> HttpResponse {
    [1, 2, 3][..].into()
}

Building a custom response:

use azure_functions::bindings::{HttpRequest, HttpResponse};
use azure_functions::func;
use azure_functions::http::Status;

#[func]
pub fn example(_req: HttpRequest) -> HttpResponse {
    HttpResponse::build()
        .status(Status::MovedPermanently)
        .header("Location", "http://example.com")
        .body("The requested resource has moved to: http://example.com")
        .finish()
}

Implementations§

Source §

impl HttpResponse

Source

pub fn build() -> ResponseBuilder

Creates a new ResponseBuilder for building a response.

§Examples

use azure_functions::http::Status;

let response = HttpResponse::build().status(Status::NotFound).finish();
assert_eq!(response.status(), Status::NotFound);

Source

pub fn status(&self) -> Status

Gets the status code for the response.

§Examples

use azure_functions::http::Status;

let response = HttpResponse::build().status(Status::BadRequest).finish();
assert_eq!(response.status(), Status::BadRequest);

Source

pub fn body(&self) -> Body<'_>

Gets the body of the response.

§Examples

let response = HttpResponse::build().body("example").finish();

assert_eq!(response.body().as_str().unwrap(), "example");

Source

pub fn headers(&self) -> &HashMap<String, String>

Gets the headers of the response.

§Examples

let response = HttpResponse::build().header("Content-Type", "text/plain").finish();

assert_eq!(response.headers().get("Content-Type").unwrap(), "text/plain");