Struct ciboulette::CibouletteUpdateRequest

pub struct CibouletteUpdateRequest<'request> {
    pub resource_type: Arc<CibouletteResourceType>,
    pub resource_id: CibouletteId<'request>,
    pub related_type: Option<Arc<CibouletteResourceType>>,
    pub path: CiboulettePath<'request>,
    pub query: CibouletteQueryParameters<'request>,
    pub data: CibouletteUpdateRequestType<'request>,
    pub meta: Option<Value>,
    pub expected_response_type: CibouletteResponseRequiredType,
}

An UPDATE request

Fields

resource_type: Arc<CibouletteResourceType>

The base type beeing updated

resource_id: CibouletteId<'request>

The resource id on which the update is based

related_type: Option<Arc<CibouletteResourceType>>

If updating a relationships, the related type

path: CiboulettePath<'request>

The path used to query

query: CibouletteQueryParameters<'request>

The query parameters included

data: CibouletteUpdateRequestType<'request>

The update requests data provided by the client

meta: Option<Value>

The meta data included by the client

expected_response_type: CibouletteResponseRequiredType

The expected response type for that request

Implementations

impl<'request> CibouletteUpdateRequest<'request>

pub fn resource_type(&self) -> &Arc<CibouletteResourceType>

The base type beeing updated

pub fn resource_id(&self) -> &CibouletteId<'request>

The resource id on which the update is based

pub fn related_type(&self) -> &Option<Arc<CibouletteResourceType>>

If updating a relationships, the related type

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

The path used to query

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

The query parameters included

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

The update requests data provided by the client

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

The meta data included by the client

pub fn expected_response_type(&self) -> &CibouletteResponseRequiredType

The expected response type for that request

Trait Implementations

impl<'request> CibouletteRequestCommons<'request> for CibouletteUpdateRequest<'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 intention(&self) -> CibouletteIntention

Get a reference to the request intention (method)

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

The expected response type when building a response for that request

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 CibouletteUpdateRequest<'request>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'request> Debug for CibouletteUpdateRequest<'request>

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

Formats the value using the given formatter.

impl<'request> TryFrom<CibouletteRequest<'request>> for CibouletteUpdateRequest<'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.