Struct HttpResponse

Source

pub struct HttpResponse<Body = BoxBody> { /* private fields */ }

Expand description

The HTTP response struct

Implementations§

Source §

impl HttpResponse<BoxBody>

Source

pub fn new<T: TryInto<StatusCode>>(status_code: T) -> Self
where T::Error: Debug,

Create a new instance of the HttpResponse struct with a specific status code.

Examples found in repository ?

examples/basic.rs (line 93)

88async fn not_working(
89    path: HttpPath<(u8, String)>,
90) -> Result<impl Responder<Body = BoxBody>, HttpServerError> {
91    let (id, name) = path.into_inner();
92
93    Ok(HttpResponse::new(200).body((id.to_string(), name)))
94}

Source

pub fn status_code(&self) -> StatusCode

Get the status code of the response

Source

pub fn headers(&self) -> &HeaderMap

Get the headers of the response

Source

pub fn headers_mut(&mut self) -> &mut HeaderMap

Get the mutable headers of the response

Source

pub fn set_body(self, body: BoxBody) -> Self

Set the body of the response

Source

pub fn body(self, body: B) -> Self
where B: MessageBody + Clone + 'static,

Sets the body for the response.

The provided body must implement both MessageBody and Clone, and it must have a 'static lifetime to be compatible.

§Note

Sending tuples as the body is supported, but it’s important to note that the layout of tuple elements may be unpredictable when serialized to bytes, as Rust does not guarantee element ordering in tuples.

§Parameters

body: The body content to be set for the response, implementing MessageBody and Clone.

§Returns

Returns Self, allowing for method chaining.

§Example


let response = HttpResponse::new(200)
    .body("Hello, world!");

Examples found in repository ?

examples/basic.rs (line 93)

88async fn not_working(
89    path: HttpPath<(u8, String)>,
90) -> Result<impl Responder<Body = BoxBody>, HttpServerError> {
91    let (id, name) = path.into_inner();
92
93    Ok(HttpResponse::new(200).body((id.to_string(), name)))
94}

Source

pub fn Ok() -> Self

Creates a new HttpResponse with a status code of 200 (OK).

Examples found in repository ?

examples/device_id.rs (line 107)

78async fn devices() -> HttpResponse {
79    let devices = [
80        Device {
81            id: 1,
82            mac: String::from("5F-33-CC-1F-43-82"),
83            firmware: String::from("2.1.6"),
84        },
85        Device {
86            id: 2,
87            mac: String::from("EF-2B-C4-F5-D6-34"),
88            firmware: String::from("2.1.5"),
89        },
90        Device {
91            id: 3,
92            mac: String::from("62-46-13-B7-B3-A1"),
93            firmware: String::from("3.0.0"),
94        },
95        Device {
96            id: 4,
97            mac: String::from("96-A8-DE-5B-77-14"),
98            firmware: String::from("1.0.1"),
99        },
100        Device {
101            id: 5,
102            mac: String::from("7E-3B-62-A6-09-12"),
103            firmware: String::from("3.5.6"),
104        },
105    ];
106
107    HttpResponse::Ok().json(&devices)
108}

Source

pub fn json(self, data: &B) -> Self
where B: Serialize,

Creates a new HttpResponse with a status code of 201 (Created).

Examples found in repository ?

examples/device_id.rs (line 107)

78async fn devices() -> HttpResponse {
79    let devices = [
80        Device {
81            id: 1,
82            mac: String::from("5F-33-CC-1F-43-82"),
83            firmware: String::from("2.1.6"),
84        },
85        Device {
86            id: 2,
87            mac: String::from("EF-2B-C4-F5-D6-34"),
88            firmware: String::from("2.1.5"),
89        },
90        Device {
91            id: 3,
92            mac: String::from("62-46-13-B7-B3-A1"),
93            firmware: String::from("3.0.0"),
94        },
95        Device {
96            id: 4,
97            mac: String::from("96-A8-DE-5B-77-14"),
98            firmware: String::from("1.0.1"),
99        },
100        Device {
101            id: 5,
102            mac: String::from("7E-3B-62-A6-09-12"),
103            firmware: String::from("3.5.6"),
104        },
105    ];
106
107    HttpResponse::Ok().json(&devices)
108}