Struct Response

pub struct Response<S: ResponseCode> { /* private fields */ }

An HTTP response.

Implementations

impl<S: ResponseCode> Response<S>

pub fn new(code: S) -> Self

Creates a new instance.

pub fn with_context<Ctx: RequestContext>(code: S, ctx: &Ctx) -> Self

Creates a new instance with the request context.

pub fn context<Ctx: RequestContext>(self, ctx: &Ctx) -> Self

Provides the request context for the response.

pub fn render<T: Serialize>(self, template_name: &str, data: T) -> Self

Available on crate feature view only.

Renders a template with the data and sets it as the reponse.

pub fn set_code(&mut self, code: S)

Sets the response code.

pub fn set_status_code(&mut self, status_code: impl Into<u16>)

Sets the status code.

pub fn set_error_code(&mut self, error_code: impl Into<S::ErrorCode>)

Sets the error code.

pub fn set_business_code(&mut self, business_code: impl Into<S::BusinessCode>)

Sets the bussiness code.

pub fn set_instance(&mut self, instance: impl Into<SharedString>)

Sets a URI reference that identifies the specific occurrence of the problem.

pub fn set_message(&mut self, message: impl Into<SharedString>)

Sets the message. If the response is not successful, it should be a human-readable explanation specific to this occurrence of the problem.

pub fn set_error_message(&mut self, error: impl Into<Error>)

Sets the error message.

pub fn set_data<T: Serialize>(&mut self, data: &T)

Sets the response data.

pub fn set_json_data(&mut self, data: impl Into<JsonValue>)

Sets the JSON data.

pub fn set_bytes_data(&mut self, data: impl Into<Bytes>)

Sets the bytes data.

pub fn set_validation_data(&mut self, validation: Validation)

Sets the response data for the validation.

pub fn set_data_transformer(&mut self, transformer: DataTransformer)

Sets a transformer for the response data.

pub fn set_content_type(&mut self, content_type: impl Into<SharedString>)

Sets the content type.

Note

Currently, we have built-in support for the following values:

• application/json
• application/jsonlines
• application/octet-stream
• application/problem+json
• application/x-www-form-urlencoded
• text/csv
• text/html
• text/plain

pub fn set_form_response(&mut self, data: impl Into<JsonValue>)

Sets the form data as the response body.

pub fn set_json_response(&mut self, data: impl Into<JsonValue>)

Sets the JSON data as the response body.

pub fn set_jsonlines_response(&mut self, data: impl Into<JsonValue>)

Sets the JSON Lines data as the response body.

pub fn set_csv_response(&mut self, data: impl Into<JsonValue>)

Sets the CSV data as the response body.

pub fn set_text_response(&mut self, data: impl Into<String>)

Sets the plain text as the response body.

pub fn set_bytes_response(&mut self, data: impl Into<Bytes>)

Sets the bytes data as the response body.

pub fn set_cookie(&mut self, cookie: &Cookie<'_>)

Available on crate feature cookie only.

Sends a cookie to the user agent.

pub fn record_server_timing( &mut self, name: impl Into<SharedString>, description: impl Into<Option<SharedString>>, duration: impl Into<Option<Duration>>, )

Records a server timing metric entry.

pub fn insert_header(&mut self, name: &'static str, value: impl ToString)

Inserts a custom header.

pub fn get_header(&self, name: &str) -> Option<&str>

Gets a custome header with the given name.

pub fn status_code(&self) -> u16

Returns the status code as u16.

pub fn error_code(&self) -> Option<&S::ErrorCode>

Returns the error code.

pub fn business_code(&self) -> Option<&S::BusinessCode>

Returns the business code.

pub fn is_success(&self) -> bool

Returns true if the response is successful or false otherwise.

pub fn has_context(&self) -> bool

Returns true if the response has a request context.

pub fn message(&self) -> Option<&str>

Returns the message.

pub fn request_id(&self) -> Uuid

Returns the request ID.

pub fn trace_id(&self) -> Uuid

Returns the trace ID.

pub fn content_type(&self) -> &str

Returns the content type.

pub fn headers(&self) -> &HeaderMap<String>

Returns a reference to the custom headers.

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

Returns a mutable reference to the custom headers.

pub fn trace_context(&self) -> (String, String)

Returns the trace context in the form (traceparent, tracestate).

pub fn server_timing(&self) -> String

Returns the server timing.

pub fn read_bytes(&mut self) -> Result<Bytes, Error>

Reads the response into a byte buffer.

pub fn response_time(&self) -> Duration

Gets the response time.

Note

It should only be called when the response will finish.

pub fn send_file(&mut self, file: NamedFile)

Sends a file to the client.

pub fn send_inertia_page(&mut self, page: InertiaPage)

Available on crate feature inertia only.

Sends an Inertia page to the client.

pub fn emit<Ctx: RequestContext>(self, ctx: &Ctx) -> Self

Emits the response for the request.

pub fn finalize(self) -> HeaderMap<String>

Consumes self and returns the custom headers.

impl Response<StatusCode>

pub fn ok() -> Self

Constructs a new response with status 200 OK.

pub fn created() -> Self

Constructs a new response with status 201 Created.

pub fn bad_request() -> Self

Constructs a new response with status 400 Bad Request.

pub fn unauthorized() -> Self

Constructs a new response with status 401 Unauthorized.

pub fn forbidden() -> Self

Constructs a new response with status 403 Forbidden.

pub fn not_found() -> Self

Constructs a new response with status 404 Not Found.

pub fn method_not_allowed() -> Self

Constructs a new response with status 405 Method Not Allowed.

pub fn conflict() -> Self

Constructs a new response with status 409 Conflict.

pub fn internal_server_error() -> Self

Constructs a new response with status 500 Internal Server Error.

pub fn service_unavailable() -> Self

Constructs a new response with status 503 Service Unavailable.

Trait Implementations

impl<S: Clone + ResponseCode> Clone for Response<S>

where S::ErrorCode: Clone, S::BusinessCode: Clone,

fn clone(&self) -> Response<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug + ResponseCode> Debug for Response<S>

where S::ErrorCode: Debug, S::BusinessCode: Debug,

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

Formats the value using the given formatter.

impl<S: ResponseCode> Default for Response<S>

fn default() -> Self

Returns the “default value” for a type.

impl From<Rejection> for Response<StatusCode>

fn from(rejection: Rejection) -> Self

Converts to this type from the input type.

impl<S: ResponseCode> From<Validation> for Response<S>

fn from(validation: Validation) -> Self

Converts to this type from the input type.

impl<S: ResponseCode> Serialize for Response<S>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.