Struct ResourceObject

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

Expand description

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: Option<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

Implementations§

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: Clone + Attributes + Serialize + DeserializeOwned> Clone for ResourceObject<A>

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

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

fn default() -> Self

Returns the “default value” for a type. Read more

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

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

1.0.0 · Source§

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<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<&ResourceObject<A>> for Identifier
where A: Attributes + SerializeTrait + DeserializeOwned,

type Error = ObjectConversionError

The type returned in the event of a conversion error.

fn try_from(ro: &ResourceObject<A>) -> 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<ResourceObject<A>> for Identifier
where A: Attributes + SerializeTrait + DeserializeOwned,

type Error = ObjectConversionError

The type returned in the event of a conversion error.

fn try_from(ro: ResourceObject<A>) -> Result<Self, Self::Error>

Performs the conversion.

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

Auto Trait Implementations§

impl<A> Freeze for ResourceObject<A>
where A: Freeze,

impl<A> RefUnwindSafe for ResourceObject<A>
where A: RefUnwindSafe,

impl<A> Send for ResourceObject<A>
where A: Send,

impl<A> Sync for ResourceObject<A>
where A: Sync,

impl<A> Unpin for ResourceObject<A>
where A: Unpin,

impl<A> UnwindSafe for ResourceObject<A>
where A: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.