Struct ciboulette::CibouletteReadRequest

pub struct CibouletteReadRequest<'request> {
    pub path: CiboulettePath<'request>,
    pub query: CibouletteQueryParameters<'request>,
    pub data: CibouletteResourceSelector<'request, MessyJsonObjectValue<'request>, CibouletteResourceIdentifier<'request>>,
    pub meta: Option<Value>,
    pub expected_response_type: CibouletteResponseRequiredType,
}

A ‘GET’ request

Fields

path: CiboulettePath<'request>

The path used to query

query: CibouletteQueryParameters<'request>

The query parameters used

data: CibouletteResourceSelector<'request, MessyJsonObjectValue<'request>, CibouletteResourceIdentifier<'request>>

The included data if any

meta: Option<Value>

The meta data sent by the client

expected_response_type: CibouletteResponseRequiredType

The expected response type

Implementations

impl<'request> CibouletteReadRequest<'request>

pub fn path(&self) -> &CiboulettePath<'request>

The path used to query

pub fn query(&self) -> &CibouletteQueryParameters<'request>

The query parameters used

pub fn data(
    &self
) -> &CibouletteResourceSelector<'request, MessyJsonObjectValue<'request>, CibouletteResourceIdentifier<'request>>

The included data if any

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

The meta data sent by the client

pub fn expected_response_type(&self) -> &CibouletteResponseRequiredType

The expected response type

Trait Implementations

impl<'request> CibouletteRequestCommons<'request> for CibouletteReadRequest<'request>

fn path(&self) -> &CiboulettePath<'request>

Get a reference to request path

fn query(&self) -> &CibouletteQueryParameters<'request>

Get a reference to request query parameters

fn expected_type(&self) -> &Arc<CibouletteResourceType>

The expected response type when building a response for that request

fn intention(&self) -> CibouletteIntention

Get a reference to the request intention (method)

fn expected_response_type(&self) -> &CibouletteResponseRequiredType

Get the expected response type for that request

fn anchor_type(&self) -> &Arc<CibouletteResourceType>

The type on which relationships should be based on

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

Meta data included by the client, if any

impl<'request> Clone for CibouletteReadRequest<'request>

fn clone(&self) -> CibouletteReadRequest<'request>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'request> Debug for CibouletteReadRequest<'request>

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

Formats the value using the given formatter.

impl<'request> TryFrom<CibouletteRequest<'request>> for CibouletteReadRequest<'request>

type Error = CibouletteError

The type returned in the event of a conversion error.

fn try_from(value: CibouletteRequest<'request>) -> Result<Self, Self::Error>

Performs the conversion.