Struct OcpiReply 

pub struct OcpiReply<T> { /* private fields */ }

Available on crate feature server only.

An OCPI response on its way out: the envelope, plus the headers that must accompany it.

Every OCPI response carries the request and correlation IDs it was called with:

Every request SHALL contain a unique request ID, the response to this request SHALL contain the same ID.

so this type carries them rather than leaving it to each handler to remember.

Implementations

impl<T: Validate> OcpiReply<T>

pub fn ok(data: T) -> Self

A 1000 Generic success reply with a payload, answered with HTTP 200.

The payload is validated on its way out, every violation is logged by JSON Pointer at warn, and it is sent anyway. Refusing a partner’s GET because one Location in a page of a hundred has a 46-character name turns this party’s data quality into an outage on theirs; serving it silently is how it becomes their support ticket weeks later.

A handler that would rather refuse calls validate itself and returns OcpiError::Invalid.

pub fn created(data: T) -> Self

A 1000 reply for an object that was newly created, answered with HTTP 201.

HTTP 201 - Created when the object has been newly created in the server system.

impl<T> OcpiReply<T>

pub fn no_content() -> Self

A 1000 reply with no payload, for a PUT or PATCH whose response body is unspecified.

We also advise that in such cases, platform sending the response leave the data field unset in the response format.

pub fn with_ids(self, ids: RequestIds) -> Self

Attaches the request and correlation IDs of the request being answered.

pub fn with_routing(self, routing: RoutingHeaders) -> Self

Attaches the routing headers of the response.

Pass the headers already swapped for the response direction; see RoutingHeaders::response_from.

pub fn with_headers(self, headers: HeaderMap) -> Self

Adds arbitrary response headers, such as the pagination trio or a Location.

pub const fn with_http_status(self, status: HttpStatus) -> Self

Overrides the HTTP status.

pub fn with_message(self, message: impl Into<String>) -> Self

Sets the status_message.

pub const fn envelope(&self) -> &OcpiResponse<T>

The envelope that will be sent.

Trait Implementations

impl<T: Debug> Debug for OcpiReply<T>

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

Formats the value using the given formatter.

impl<T: Serialize> IntoResponse for OcpiReply<T>

fn into_response(self) -> Response

Create a response.