Struct jsonapi::api::Resource

pub struct Resource {
    pub _type: String,
    pub id: JsonApiId,
    pub attributes: ResourceAttributes,
    pub relationships: Option<Relationships>,
    pub links: Option<Links>,
    pub meta: Option<Meta>,
}

Representation of a JSON:API resource. This is a struct that contains attributes that map to the JSON:API specification of id, type, attributes, relationships, links, and meta

Fields

_type: String

id: JsonApiId

attributes: ResourceAttributes

relationships: Option<Relationships>

links: Option<Links>

meta: Option<Meta>

Methods

impl Resource

pub fn get_relationship(&self, name: &str) -> Option<&Relationship>

pub fn get_attribute(&self, name: &str) -> Option<&JsonApiValue>

Get an attribute JsonApiValue

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

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

match Resource::from_str(&serialized) {
  Err(_)=> assert!(false),
  Ok(resource)=> {
    match resource.get_attribute("title") {
      None => assert!(false),
      Some(attr) => {
        match attr.as_str() {
          None => assert!(false),
          Some(s) => {
              assert_eq!(s, "Rails is Omakase");
          }
        }
      }
    }
  }
}

pub fn diff(&self, other: Resource) -> Result<PatchSet, DiffPatchError>

pub fn patch(&mut self, patchset: PatchSet) -> Result<Resource>

Trait Implementations

impl Clone for Resource

fn clone(&self) -> Resource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Resource

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

Formats the value using the given formatter.

impl Default for Resource

fn default() -> Resource

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Resource

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

Deserialize this value from the given Serde deserializer.

impl FromStr for Resource

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::Resource;
use std::str::FromStr;

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

let data = Resource::from_str(&serialized);
assert_eq!(data.is_ok(), true);

impl PartialEq<Resource> for Resource

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

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

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

This method tests for !=.

impl Serialize for Resource

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 Resource