Struct ciboulette::CibouletteBody

pub struct CibouletteBody<'request, I, B> {
    pub jsonapi: Option<CibouletteJsonApiVersion<'request>>,
    pub links: Option<CibouletteBodyLink<'request>>,
    pub data: CibouletteBodyData<'request, I, B>,
    pub errors: Option<CibouletteErrorObj<'request>>,
    pub meta: Option<Value>,
    pub included: Vec<CibouletteResource<'request, B, I>>,
}

A json:api document object

This struct hold the top level document of a request or a response

Use CibouletteBodyBuilder to be build.

Fields

jsonapi: Option<CibouletteJsonApiVersion<'request>>

The semver of the JSON:API specs

links: Option<CibouletteBodyLink<'request>>

Links to the current object/relationship

data: CibouletteBodyData<'request, I, B>

The data of the request/response. Cannot be set with errors.

errors: Option<CibouletteErrorObj<'request>>

The error object of the response. Cannot be set with data.

meta: Option<Value>

The meta object.

included: Vec<CibouletteResource<'request, B, I>>

The included objects. Cannot be set without data

Implementations

impl<'request, I, B> CibouletteBody<'request, I, B>

pub fn jsonapi(&self) -> &Option<CibouletteJsonApiVersion<'request>>

The semver of the JSON:API specs

pub fn links(&self) -> &Option<CibouletteBodyLink<'request>>

Links to the current object/relationship

pub fn data(&self) -> &CibouletteBodyData<'request, I, B>

The data of the request/response. Cannot be set with errors.

pub fn errors(&self) -> &Option<CibouletteErrorObj<'request>>

The error object of the response. Cannot be set with data.

pub fn meta(&self) -> &Option<Value>

The meta object.

pub fn included(&self) -> &Vec<CibouletteResource<'request, B, I>>

The included objects. Cannot be set without data

impl<'request, I, B> CibouletteBody<'request, I, B>

pub fn jsonapi_mut(&mut self) -> &mut Option<CibouletteJsonApiVersion<'request>>

The semver of the JSON:API specs

pub fn links_mut(&mut self) -> &mut Option<CibouletteBodyLink<'request>>

Links to the current object/relationship

pub fn data_mut(&mut self) -> &mut CibouletteBodyData<'request, I, B>

The data of the request/response. Cannot be set with errors.

pub fn errors_mut(&mut self) -> &mut Option<CibouletteErrorObj<'request>>

The error object of the response. Cannot be set with data.

pub fn meta_mut(&mut self) -> &mut Option<Value>

The meta object.

pub fn included_mut(&mut self) -> &mut Vec<CibouletteResource<'request, B, I>>

The included objects. Cannot be set without data

impl<'request, I, B> CibouletteBody<'request, I, B>

pub fn is_compound(&self) -> bool

Check if the request is a compound document

pub fn has_data(&self) -> bool

Check if the request has data

impl<'request, B> CibouletteBody<'request, CibouletteResourceIdentifierPermissive<'request>, B>

pub fn get_main_type(
    &self,
    bag: &CibouletteStore
) -> Option<Arc<CibouletteResourceType>>

Get the main type of the request If it’s a single document request, the type of the document is used. If it’s a compound document request and all the document are the same type, then this type is used. Else None is returned

pub fn has_all_ids(&self) -> bool

Check if the request has all its id set (not always the case in creating requests)

true if there is no data

Trait Implementations

impl<'request, I: Clone, B: Clone> Clone for CibouletteBody<'request, I, B>

fn clone(&self) -> CibouletteBody<'request, I, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'request, I: Debug, B: Debug> Debug for CibouletteBody<'request, I, B>

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

Formats the value using the given formatter.

impl<'request, I, B> Default for CibouletteBody<'request, I, B> where
    B: Default, 

fn default() -> Self

Returns the “default value” for a type.

impl<'request, I, B> Serialize for CibouletteBody<'request, I, B> where
    I: Serialize,
    B: Serialize, 

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

Serialize this value into the given Serde serializer.