Struct jsonapi::api::JsonApiDocument

pub struct JsonApiDocument {
    pub data: Option<PrimaryData>,
    pub included: Option<Resources>,
    pub links: Option<Links>,
    pub meta: Option<Meta>,
    pub errors: Option<JsonApiErrors>,
    pub jsonapi: Option<JsonApiInfo>,
}

The specification refers to this as a top-level document

Fields

data: Option<PrimaryData>

included: Option<Resources>

links: Option<Links>

meta: Option<Meta>

errors: Option<JsonApiErrors>

jsonapi: Option<JsonApiInfo>

Methods

impl JsonApiDocument

Top-level JSON-API Document

pub fn is_valid(&self) -> bool

This function returns false if the JsonApiDocument contains any violations of the specification. See DocumentValidationError

The spec dictates that the document must have least one of data, errors or meta. Of these, data and errors must not co-exist. The optional field included may only be present if the data field is present too.

use jsonapi::api::{JsonApiDocument, PrimaryData, JsonApiErrors};
let doc = JsonApiDocument {
    data: Some(PrimaryData::None),
    errors: Some(JsonApiErrors::new()),
    ..Default::default()
};

assert_eq!(doc.is_valid(), false);

pub fn validate(&self) -> Option<Vec<DocumentValidationError>>

This function returns a Vec with identified specification violations enumerated in DocumentValidationError

use jsonapi::api::{JsonApiDocument, PrimaryData, JsonApiErrors, DocumentValidationError};

let doc = JsonApiDocument {
    data: Some(PrimaryData::None),
    errors: Some(JsonApiErrors::new()),
    ..Default::default()
};

match doc.validate() {
  Some(errors) => {
    assert!(
      errors.contains(
        &DocumentValidationError::DataWithErrors
      )
    )
  }
  None => assert!(false)
}

Trait Implementations

impl Clone for JsonApiDocument

fn clone(&self) -> JsonApiDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsonApiDocument

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

Formats the value using the given formatter.

impl Default for JsonApiDocument

fn default() -> JsonApiDocument

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for JsonApiDocument

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

Deserialize this value from the given Serde deserializer.

impl FromStr for JsonApiDocument

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Instantiate from string

use jsonapi::api::JsonApiDocument;
use std::str::FromStr;

let serialized = r#"{
  "data" : [
    { "id":"1", "type":"post", "attributes":{}, "relationships":{}, "links" :{} },
    { "id":"2", "type":"post", "attributes":{}, "relationships":{}, "links" :{} },
    { "id":"3", "type":"post", "attributes":{}, "relationships":{}, "links" :{} }
  ]
}"#;
let doc = JsonApiDocument::from_str(&serialized);
assert_eq!(doc.is_ok(), true);

impl PartialEq<JsonApiDocument> for JsonApiDocument

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

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

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

This method tests for !=.

impl Serialize for JsonApiDocument

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 JsonApiDocument