Trait uiuifree_actix_web_util::Responder

source · [−]
pub trait Responder {
    type Body: 'static + MessageBody;

    fn respond_to(self, req: &HttpRequest) -> HttpResponse<Self::Body>;

    fn customize(self) -> CustomizeResponder<Self> { ... }
}
Expand description

Trait implemented by types that can be converted to an HTTP response.

Any types that implement this trait can be used in the return type of a handler. Since handlers will only have one return type, it is idiomatic to use opaque return types -> impl Responder.

Implementations

It is often not required to implement Responder for your own types due to a broad base of built-in implementations:

Customizing Responder Output

Calling .customize() on any responder type will wrap it in a CustomizeResponder capable of overriding various parts of the response such as the status code and header map.

Required Associated Types

Required Methods

Convert self to HttpResponse.

Provided Methods

Wraps responder to allow alteration of its response.

See CustomizeResponder docs for more details on its capabilities.

Examples
use actix_web::{Responder, http::StatusCode, test::TestRequest};

let responder = "Hello world!"
    .customize()
    .with_status(StatusCode::BAD_REQUEST)
    .insert_header(("x-hello", "world"));

let request = TestRequest::default().to_http_request();
let response = responder.respond_to(&request);
assert_eq!(response.status(), StatusCode::BAD_REQUEST);
assert_eq!(response.headers().get("x-hello").unwrap(), "world");

Implementations on Foreign Types

Implementors

See here for example of usage as a handler return type.

See here for example of usage as a handler return type.

Creates response with OK status code, correct content type header, and serialized JSON payload.

If serialization failed