Struct Resource 

pub struct Resource<T> {
    pub data: T,
    pub links: HashMap<String, LinkOrArray>,
    pub embedded: Option<HashMap<String, Value>>,
}

Resource wrapper with HATEOAS links (HAL format)

Wraps any data type with _links and optional _embedded sections.

Example

use rustapi_core::hateoas::Resource;
use serde::Serialize;

#[derive(Serialize)]
struct User {
    id: i64,
    name: String,
}

let user = User { id: 1, name: "John".to_string() };
let resource = Resource::new(user)
    .self_link("/users/1")
    .link("orders", "/users/1/orders");

Fields

data: T

The actual resource data (flattened into the JSON)

links: HashMap<String, LinkOrArray>

Hypermedia links

embedded: Option<HashMap<String, Value>>

Embedded resources

Implementations

impl<T> Resource<T>

pub fn new(data: T) -> Resource<T>

Create a new resource wrapper

pub fn link( self, rel: impl Into<String>, href: impl Into<String>, ) -> Resource<T>

Add a link with the given relation

pub fn link_object(self, rel: impl Into<String>, link: Link) -> Resource<T>

Add a link object

pub fn links(self, rel: impl Into<String>, links: Vec<Link>) -> Resource<T>

Add multiple links for the same relation

pub fn self_link(self, href: impl Into<String>) -> Resource<T>

Add the canonical self link

pub fn embed<E>( self, rel: impl Into<String>, resources: E, ) -> Result<Resource<T>, Error>

where E: Serialize,

Add embedded resources

pub fn embed_raw(self, rel: impl Into<String>, value: Value) -> Resource<T>

Add pre-serialized embedded resources

Trait Implementations

impl<T> Clone for Resource<T>

where T: Clone,

fn clone(&self) -> Resource<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Resource<T>

where T: Debug,

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

Formats the value using the given formatter.

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

where T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Resource<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for Resource<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.