Struct siren_types::Entity

pub struct Entity {
    pub class: Vec<String>,
    pub properties: Value,
    pub entities: Vec<SubEntity>,
    pub links: Vec<NavigationalLink>,
    pub actions: Vec<Action>,
    pub title: Option<String>,
}

Fields

class: Vec<String>

Describes the nature of an entity's content based on the current representation. Possible values are implementation-dependent and should be documented. MUST be an array of strings. Optional.

properties: Value

A set of key-value pairs that describe the state of an entity. In JSON Siren, this is an object such as { "name": "Kevin", "age": 30 }. Optional.

entities: Vec<SubEntity>

A collection of related sub-entities. If a sub-entity contains an href value, it should be treated as an embedded link. Clients may choose to optimistically load embedded links. If no href value exists, the sub-entity is an embedded entity representation that contains all the characteristics of a typical entity. One difference is that a sub-entity MUST contain a rel attribute to describe its relationship to the parent entity.

links: Vec<NavigationalLink>

A collection of items that describe navigational links, distinct from entity relationships. Link items should contain a rel attribute to describe the relationship and an href attribute to point to the target URI. Entities should include a link rel to self. In JSON Siren, this is represented as "links": [{ "rel": ["self"], "href": "http://api.x.io/orders/1234" }] Optional.

actions: Vec<Action>

A collection of action objects, represented in JSON Siren as an array such as { "actions": [{ ... }] }. See Actions. Optional

title: Option<String>

Descriptive text about the entity. Optional.

Implementations

impl Entity

pub fn with_properties<S: Serialize>(
    self,
    serializable: S
) -> Result<Self, EntityBuilderError>

pub fn with_class_member(self, class_member: impl Into<String>) -> Self

pub fn with_link(self, link: NavigationalLink) -> Self

pub fn with_action(self, action: Action) -> Self

pub fn push_sub_entity(&mut self, sub_entity: SubEntity)

Trait Implementations

impl Debug for Entity

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

Formats the value using the given formatter.

impl Default for Entity

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Entity

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Entity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.