Struct postcard_rpc::Dispatch

pub struct Dispatch<Context, Error, const N: usize> { /* private fields */ }

Dispatch is the primary interface for MCU “server” devices.

Dispatch is generic over three types:

1. The Context, which will be passed as a mutable reference to each of the handlers. It typically should contain whatever resource is necessary to send replies back to the host.
2. The Error type, which can be returned by handlers
3. N, for the maximum number of handlers

If you plan to use COBS encoding, you can also use CobsDispatch. which will automatically handle accumulating bytes from the wire.

Note: This will be available when the cobs or cobs-serial feature is enabled.

Implementations

impl<Context, Err, const N: usize> Dispatch<Context, Err, N>

pub fn new(c: Context) -> Self

Create a new Dispatch

pub fn add_handler<E: Endpoint>( &mut self, handler: fn(_: &WireHeader, _: &mut Context, _: &[u8]) -> Result<(), Err> ) -> Result<(), &'static str>

Add a handler to the Dispatch for the given path and type

Returns an error if the given type+path have already been added, or if Dispatch is full.

pub fn context(&mut self) -> &mut Context

Accessor function for the Context field

pub fn dispatch(&mut self, bytes: &[u8]) -> Result<(), Error<Err>>

Attempt to dispatch the given message

The bytes should consist of exactly one message (including the header).

Returns an error in any of the following cases:

• We failed to decode a header
• No handler was found for the decoded key
• The handler ran, but returned an error