Struct coap_handler_implementations::TypeHandler

pub struct TypeHandler<H, S: TypeSerializer = SerdeCBORSerialization>
where
    H: TypeRenderable,
{ /* private fields */ }

Wrapper for resource handlers that are implemented in terms of GETting, POSTing or PUTting objects in CBOR format.

The wrapper handles all encoding and decoding, options processing (ignoring the critical Uri-Path option under the assumption that that has been already processed by an underlying request router), the corresponding errors and block-wise GETs.

More complex handlers (eg. implementing additional representations, or processing query aprameters into additional data available to the TypeRenderable) can be built by forwarding to this (where any critical but already processed options would need to be masked from the message’s option) or taking inspiration from it.

Implementations

impl<H> TypeHandler<H, SerdeCBORSerialization>

where H: TypeRenderable, H::Get: for<'de> Serialize, H::Post: for<'de> Deserialize<'de>, H::Put: for<'de> Deserialize<'de>,

pub fn new(handler: H) -> Self

impl<H> TypeHandler<H, MiniCBORSerialization>

where H: TypeRenderable, H::Get: for<'de> Encode<()>, H::Post: for<'de> Decode<'de, ()>, H::Put: for<'de> Decode<'de, ()>,

pub fn new_minicbor(handler: H) -> Self

Trait Implementations

impl<H> Handler for TypeHandler<H, SerdeCBORSerialization>

where H: TypeRenderable, H::Get: for<'de> Serialize, H::Post: for<'de> Deserialize<'de>, H::Put: for<'de> Deserialize<'de>,

type RequestData = TypeRequestData

Type constructed in extract_request_data() passed on to build_response().

type ExtractRequestError = Error

Error type for extract_request_data().

type BuildResponseError<M: MinimalWritableMessage> = <M as MinimalWritableMessage>::UnionError

Error type for writing response data.

fn extract_request_data<M: ReadableMessage>( &mut self, request: &M ) -> Result<Self::RequestData, Error>

Process an incoming request.

fn estimate_length(&mut self, request: &Self::RequestData) -> usize

Estimate an upper bound for the number of bytes in the response

fn build_response<M: MutableWritableMessage>( &mut self, response: &mut M, request: Self::RequestData ) -> Result<(), Self::BuildResponseError<M>>

Build a response for the request

impl<H> Handler for TypeHandler<H, MiniCBORSerialization>

where H: TypeRenderable, H::Get: for<'de> Encode<()>, H::Post: for<'de> Decode<'de, ()>, H::Put: for<'de> Decode<'de, ()>,

type RequestData = TypeRequestData

Type constructed in extract_request_data() passed on to build_response().

type ExtractRequestError = Error

Error type for extract_request_data().

type BuildResponseError<M: MinimalWritableMessage> = <M as MinimalWritableMessage>::UnionError

Error type for writing response data.

fn extract_request_data<M: ReadableMessage>( &mut self, request: &M ) -> Result<Self::RequestData, Error>

Process an incoming request.

fn estimate_length(&mut self, request: &Self::RequestData) -> usize

Estimate an upper bound for the number of bytes in the response

fn build_response<M: MutableWritableMessage>( &mut self, response: &mut M, request: Self::RequestData ) -> Result<(), Self::BuildResponseError<M>>

Build a response for the request