Enum Document

pub enum Document<T: PrimaryData> {
    Ok {
        data: Data<T>,
        included: Set<Object>,
        jsonapi: JsonApi,
        links: Map<Key, Link>,
        meta: Map,
    },
    Err {
        errors: Vec<ErrorObject>,
        jsonapi: JsonApi,
        links: Map<Key, Link>,
        meta: Map,
    },
}

Represents a compound JSON API document.

For more information, check out the document structure section of the JSON API specification.

Variants

Ok

Does not contain errors.

Fields

data: Data<T>

The primary data of the document. For more information, check out the top level section of the JSON API specification.

included: Set<Object>

Included resources, resolved from the include query parameter of a client request.

jsonapi: JsonApi

Information about this implementation of the specification that the document was created with. For more information, check out the JSON API object section of the JSON API specification.

links: Map<Key, Link>

Contains relevant links. If this value of this field is empty, it will not be serialized. For more information, check out the links section of the JSON API specification.

meta: Map

Non-standard meta information. If this value of this field is empty, it will not be serialized. For more information, check out the meta information section of the JSON API specification.

Err

Contains 1 or more error(s).

Fields

errors: Vec<ErrorObject>

jsonapi: JsonApi

links: Map<Key, Link>

meta: Map

Implementations

impl<T: PrimaryData> Document<T>

pub fn is_ok(&self) -> bool

Returns true if the document does not contain any errors.

pub fn is_err(&self) -> bool

Returns true if the document contains 1 or more error(s).

Trait Implementations

impl<T: Clone + PrimaryData> Clone for Document<T>

fn clone(&self) -> Document<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + PrimaryData> Debug for Document<T>

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

Formats the value using the given formatter.

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

where T: PrimaryData,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq + PrimaryData> PartialEq for Document<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PrimaryData> Render<T> for Document<T>

fn render(self, _: Option<&Query>) -> Result<Document<T>, Error>

Attempts to render the given type as a document.

impl<T> Serialize for Document<T>

where T: PrimaryData,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PrimaryData> StructuralPartialEq for Document<T>