json-api 0.4.1

Idiomatic types for building a robust JSON API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

use doc::{Data, Document, PrimaryData};
use error::Error;
use query::Query;

/// A trait to render a given type as a document.
///
/// This trait is automatically implemented for any type which implements [`Resource`].
///
/// [`Resource`]: ../trait.Resource.html
pub trait Render<T: PrimaryData> {
    /// 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.
    ///
    /// [`Resource`]: ../trait.Resource.html
    /// [`resource!`]: ../macro.resource.html
    fn render(self, query: Option<&Query>) -> Result<Document<T>, 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> {
        match self {
            Some(value) => value.render(query),
            None => Ok(Document::Ok {
                data: Data::Member(Box::new(None)),
                included: Default::default(),
                jsonapi: Default::default(),
                links: Default::default(),
                meta: Default::default(),
            }),
        }
    }
}