Enum JsonApiDocument

pub enum JsonApiDocument {
    Error(DocumentError),
    Data(DocumentData),
}

An enum that defines the possible composition of a JSON:API document - one which contains error or data - but not both. Rely on Rust’s type system to handle this basic validation instead of running validators on parsed documents

Variants

Error(DocumentError)

Data(DocumentData)

Implementations

impl JsonApiDocument

Top-level JSON-API Document An “error” document can be valid, just as a “data” document can be valid

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.

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

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

// Simulate an error where `included` has data but `data` does not
use jsonapi::api::*;
use std::str::FromStr;

let serialized = r#"{
  "id":"1",
  "type":"post",
  "attributes":{
    "title": "Rails is Omakase",
    "likes": 250
  },
  "relationships":{},
  "links" :{}
}"#;

let resource = Resource::from_str(&serialized);

let data = DocumentData {
    data: None,
    included: Some(vec![resource.unwrap()]),
    ..Default::default()
};

let doc = JsonApiDocument::Data(data);

match doc.validate() {
  Some(errors) => {
    assert!(
      errors.contains(
        &DocumentValidationError::IncludedWithoutData
      )
    )
  }
  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<'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

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);

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for JsonApiDocument

fn eq(&self, other: &JsonApiDocument) -> 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 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