Struct ResourceResponse 

pub struct ResourceResponse { /* private fields */ }

A resource on its way out: the data, whatever travels beside it, and the status it goes with.

Implementations

impl ResourceResponse

pub fn new(data: Json, wrap: Option<&'static str>) -> Self

pub fn additional(self, key: &str, value: impl Into<Json>) -> Self

Add a top-level key beside the data.

pub fn meta(self, key: &str, value: impl Into<Json>) -> Self

Add a key under meta.

pub fn link(self, key: &str, value: impl Into<Json>) -> Self

Add a key under links.

pub fn path(self, path: &str) -> Self

The path the pagination links are built on. Without it they are relative — ?page=2 — which every client resolves correctly against the URL it just requested.

pub fn paginate(self, current_page: i64, per_page: i64, total: i64) -> Self

Describe page-number pagination, with Laravel’s meta and links.

Three numbers rather than a Page, so this crate does not have to know about the database — and so it works for a page that came from anywhere else.

pub fn cursor(self, next_cursor: Option<String>, per_page: i64) -> Self

Describe cursor pagination: a next_cursor that is null at the end.

pub fn with_status(self, status: impl Into<Status>) -> Self

pub fn created(self) -> Self

201 Created, for the response to a successful store.

pub fn with_header(self, name: &str, value: impl Into<String>) -> Self

pub fn to_json(&self) -> Json

The body as it will be sent.

Trait Implementations

impl Clone for ResourceResponse

fn clone(&self) -> ResourceResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceResponse

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

Formats the value using the given formatter.

impl IntoResponse for ResourceResponse

fn into_response(self) -> Response