Struct Response 

pub struct Response<D = Value, M = DefaultMeta> {
    pub data: Option<D>,
    pub errors: Vec<ErrorObject>,
    pub meta: Option<M>,
    pub status_code: u16,
}

A response object folling the jsonapi format.

Note // TODO: Address these inconsistencies

This is mostly a scratch, relying in the serde_json::Value for certain scenarios

Also it does not restrict the Self::data variant (see https://jsonapi.org/format/#document-top-level for how it should look).

Fields

data: Option<D>

errors: Vec<ErrorObject>

meta: Option<M>

status_code: u16

Implementations

impl<D: Default, M: Default> Response<D, M>

pub fn error(status: u16, title: impl ToString, detail: impl ToString) -> Self

pub fn from_error(title: impl ToString, error: Error) -> Self

pub fn add_error(&mut self, error: ErrorObject) -> &mut Self

impl Response<(), Value>

pub fn no_data(message: impl ToString) -> Self

Responds with no data, but a “message” in the “meta” section

impl<D: Default> Response<D>

pub fn data(data: D) -> Self

Trait Implementations

impl<D: Clone, M: Clone> Clone for Response<D, M>

fn clone(&self) -> Response<D, M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug, M: Debug> Debug for Response<D, M>

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

Formats the value using the given formatter.

impl<D: Default, M: Default> Default for Response<D, M>

fn default() -> Response<D, M>

Returns the “default value” for a type.

impl<'de, D, M> Deserialize<'de> for Response<D, M>

where D: Deserialize<'de>, M: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Error> for Response

fn from(value: Error) -> Self

Converts to this type from the input type.

impl<D: Serialize, M: Serialize> IntoResponse for Response<D, M>

fn into_response(self) -> Response

Create a response.

impl<D, M> Serialize for Response<D, M>

where D: Serialize, M: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.