Struct ciboulette::CibouletteBodyBuilder

pub struct CibouletteBodyBuilder<'request> { /* fields omitted */ }

Builder object for CibouletteBody

Implementations

impl<'request> CibouletteBodyBuilder<'request>

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

The semver of the JSON:API specs

pub fn data(&self) -> &CibouletteBodyDataBuilder<'request>

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>

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

Links to the current object/relationship

pub fn included(&self) -> &Vec<CibouletteResourceBuilder<'request>>

The included objects. Cannot be set without data

impl<'request> CibouletteBodyBuilder<'request>

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

The semver of the JSON:API specs

pub fn data_mut(&mut self) -> &mut CibouletteBodyDataBuilder<'request>

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>

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

Links to the current object/relationship

pub fn included_mut(&mut self) -> &mut Vec<CibouletteResourceBuilder<'request>>

The included objects. Cannot be set without data

impl<'request> CibouletteBodyBuilder<'request>

pub fn check<'c>(
    intention: &CibouletteIntention,
    data: &'c CibouletteBodyData<'request, CibouletteResourceIdentifierPermissive<'request>, MessyJsonObjectValue<'request>>,
    included: &'c [CibouletteResource<'request, MessyJsonObjectValue<'request>, CibouletteResourceIdentifierPermissive<'request>>],
    errors: &'c Option<CibouletteErrorObj<'request>>
) -> Result<(), CibouletteError>

Perfom all the document checks

pub fn build(
    self,
    bag: &CibouletteStore,
    intention: &CibouletteIntention
) -> Result<CibouletteBody<'request, CibouletteResourceIdentifierPermissive<'request>, MessyJsonObjectValue<'request>>, CibouletteError>

Build a CibouletteBody from the builder.

Runs check before building

Trait Implementations

impl<'request> Debug for CibouletteBodyBuilder<'request>

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CibouletteBodyBuilder<'de>

fn deserialize<D>(
    deserializer: D
) -> Result<CibouletteBodyBuilder<'de>, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.