Struct japi::Document

pub struct Document {
    pub data: OptionalVec<GenericObject>,
    pub errors: Option<Vec<Error>>,
    pub meta: Option<Meta>,
    pub jsonapi: Option<JsonApi>,
    pub links: Option<Links>,
    pub included: Option<Vec<GenericObject>>,
}

The object at the root of every JSON:API message

For validitity it must contain at least one of data, errors, or meta

See the JSON:API docs for more information

Fields

data: OptionalVec<GenericObject>

The document's primary data

errors: Option<Vec<Error>>

Any errors that were encountered

meta: Option<Meta>

Non-standard meta information

jsonapi: Option<JsonApi>

Information about the version of JSON:API being used

links: Option<Links>

Links related to the primary data

included: Option<Vec<GenericObject>>

Included resources related to the primary data or each other

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Document

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Document> for Document

fn eq(&self, other: &Document) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Document) -> bool

This method tests for !=.

impl Serialize for Document

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Document