Struct japi::ResourceObject

pub struct ResourceObject<A: Attributes + Serialize + DeserializeOwned> {
    pub id: String,
    pub attributes: Option<A>,
    pub relationships: Option<Relationships>,
    pub links: Option<Links>,
    pub meta: Option<Meta>,
}

A resource object

Much like the object in the JSON:API docs with the notable difference that the type of the object is encoded into the strictly typed Attributes genric

Fields

id: String

The object identifier which together with A::kind must identify a unique resource

attributes: Option<A>

Attributes representing some of the resource's data

relationships: Option<Relationships>

Describes relationships between this resource and others

links: Option<Links>

Contains links relating to the resource

meta: Option<Meta>

Contains non-standard meta information

Methods

impl<A> ResourceObject<A> where
    A: Attributes + Serialize + DeserializeOwned, 

pub fn new(id: String, attributes: Option<A>) -> Self

pub fn add_relationship(&mut self, name: String, relationship: Relationship)

Inserts an entry into the relationship map, creating the map if it does not exist

pub fn add_link(&mut self, name: String, link: Link)

Inserts an entry into the link map, creating the map if it does not exist

Trait Implementations

impl<A> From<ResourceObject<A>> for GenericObject where
    A: Attributes + SerializeTrait + DeserializeOwned, 

fn from(ro: ResourceObject<A>) -> Self

Performs the conversion.

impl<'_, A> From<&'_ ResourceObject<A>> for GenericObject where
    A: Attributes + SerializeTrait + DeserializeOwned, 

fn from(ro: &ResourceObject<A>) -> Self

Performs the conversion.

impl<A> From<ResourceObject<A>> for Identifier where
    A: Attributes + SerializeTrait + DeserializeOwned, 

fn from(ro: ResourceObject<A>) -> Self

Performs the conversion.

impl<'_, A> From<&'_ ResourceObject<A>> for Identifier where
    A: Attributes + SerializeTrait + DeserializeOwned, 

fn from(ro: &ResourceObject<A>) -> Self

Performs the conversion.

impl<A: Clone + Attributes + Serialize + DeserializeOwned> Clone for ResourceObject<A>

fn clone(&self) -> ResourceObject<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: PartialEq + Attributes + Serialize + DeserializeOwned> PartialEq<ResourceObject<A>> for ResourceObject<A>

fn eq(&self, other: &ResourceObject<A>) -> bool

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

fn ne(&self, other: &ResourceObject<A>) -> bool

This method tests for !=.

impl<A: Debug + Attributes + Serialize + DeserializeOwned> Debug for ResourceObject<A>

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

Formats the value using the given formatter.

impl<A> TryFrom<GenericObject> for ResourceObject<A> where
    A: Attributes + Serialize + DeserializeOwned, 

type Error = ObjectConversionError

The type returned in the event of a conversion error.

fn try_from(go: GenericObject) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_, A> TryFrom<&'_ GenericObject> for ResourceObject<A> where
    A: Attributes + Serialize + DeserializeOwned, 

type Error = ObjectConversionError

The type returned in the event of a conversion error.

fn try_from(go: &GenericObject) -> Result<Self, Self::Error>

Performs the conversion.

impl<A> TryFrom<Identifier> for ResourceObject<A> where
    A: Attributes + Serialize + DeserializeOwned, 

type Error = ObjectConversionError

The type returned in the event of a conversion error.

fn try_from(id: Identifier) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_, A> TryFrom<&'_ Identifier> for ResourceObject<A> where
    A: Attributes + Serialize + DeserializeOwned, 

type Error = ObjectConversionError

The type returned in the event of a conversion error.

fn try_from(id: &Identifier) -> Result<Self, Self::Error>

Performs the conversion.