pub struct ConvertingReceiver<T: FromByteSlice> { /* private fields */ }
Expand description
A wrapper for Receiver
, which converts received byte vectors to structured data.
This receiver wraps a Receiver
receiving raw bytes. Calling recv
or try_recv
will call equivalent methods on the wrapped Receiver
and then convert the received bytes
to a instance of T
.
Note
Calling recv
will not block indefinitely. Instead the timeout passed to the new
method is used for
a call of recv_timeout
Type parameters
T
- Type which is created from received byte vectors. Must implementFromByteSlice
Errors
Returned errors are equivalent to those returned from methods of a Receiver
. Additionally errors
raised by the brick or bricklet, such as InvalidParameter
, FunctionNotSupported
and UnknownError
will be returned. If the received response can not be interpreted as the result type T
, a MalformedPacket
error is raised.
Note
If the device is configured to send no response for a result-less setter, the Error SuccessButResponseExpectedIsDisabled
will be returned. This indicates, that the request was sent to the device, but no further guarantees can be made.
Implementations
sourceimpl<T: FromByteSlice> ConvertingReceiver<T>
impl<T: FromByteSlice> ConvertingReceiver<T>
sourcepub fn new(
receiver: Receiver<Result<Vec<u8>, BrickletError>>,
timeout: Duration
) -> ConvertingReceiver<T>
pub fn new(
receiver: Receiver<Result<Vec<u8>, BrickletError>>,
timeout: Duration
) -> ConvertingReceiver<T>
sourcepub fn try_recv(&self) -> Result<T, BrickletTryRecvError>
pub fn try_recv(&self) -> Result<T, BrickletTryRecvError>
Attempts to return a pending value on this receiver without blocking. This method behaves like try_recv
.
Errors
Returns an error on the following conditions:
- There is no connection to a brick daemon.
- The brick or bricklet returns an error.
- The queue was disconnected or currently empty.
- Response expected was disabled for a result-less setter. This is not an error.
sourcepub fn recv(&self) -> Result<T, BrickletRecvTimeoutError>
pub fn recv(&self) -> Result<T, BrickletRecvTimeoutError>
Attempts to wait for a value on this receiver, returning an error if the corresponding channel has hung up, or if it waits more than timeout.
This method behaves like recv_timeout
.
Errors
Returns an error on one of the following conditions:
- There is no connection to a brick daemon.
- The brick or bricklet returns an error.
- The queue was disconnected.
- Response expected was disabled for a result-less setter. This is not an error.
- Blocked longer than the configured time out.