Trait json_api::view::Render

pub trait Render<T: PrimaryData> {
    fn render(self, query: Option<&Query>) -> Result<Document<T>, Error>;
}

A trait to render a given type as a document.

This trait is automatically implemented for any type which implements Resource.

Required Methods

fn render(self, query: Option<&Query>) -> Result<Document<T>, Error>

Attempts to render the given type as a document.

Types that implement the Resource trait via the resource! macro can use the optional query argument to match object field-sets and included resources with what is present in the query.

If a query does not have a matching field-set for a given type and the type in question is a part of the document's primary data or included resources, each attribute specified in the type's resource! macro invocation will be used.

Implementations on Foreign Types

impl<'a, T: Resource> Render<Identifier> for &'a T

fn render(self, query: Option<&Query>) -> Result<Document<Identifier>, Error>

impl<'a, T: Resource> Render<Identifier> for &'a [T]

fn render(self, query: Option<&Query>) -> Result<Document<Identifier>, Error>

impl<'a, T: Resource> Render<Object> for &'a T

fn render(self, query: Option<&Query>) -> Result<Document<Object>, Error>

impl<'a, T: Resource> Render<Object> for &'a [T]

fn render(self, query: Option<&Query>) -> Result<Document<Object>, Error>

impl Render<Identifier> for Vec<Identifier>

fn render(self, _: Option<&Query>) -> Result<Document<Identifier>, Error>

impl Render<Identifier> for Vec<Object>

fn render(self, _: Option<&Query>) -> Result<Document<Identifier>, Error>

impl Render<Object> for Vec<Object>

fn render(self, _: Option<&Query>) -> Result<Document<Object>, Error>

impl<D, T> Render<D> for Option<T> where
    D: PrimaryData,
    T: Render<D> + Sized, 

fn render(self, query: Option<&Query>) -> Result<Document<D>, Error>

Implementors

• impl Render<Identifier> for Identifier
• impl Render<Identifier> for Object
• impl Render<Object> for Object
• impl Render<NewObject> for NewObject
• impl<T: PrimaryData> Render<T> for Document<T>