Struct tinkerforge::converting_receiver::ConvertingReceiver [−][src]
pub struct ConvertingReceiver<T: FromByteSlice> { /* fields omitted */ }
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
impl<T: FromByteSlice> ConvertingReceiver<T>
[src]
impl<T: FromByteSlice> ConvertingReceiver<T>
[src]pub fn new(
receiver: Receiver<Result<Vec<u8>, BrickletError>>,
timeout: Duration
) -> ConvertingReceiver<T>
[src]
pub fn new(
receiver: Receiver<Result<Vec<u8>, BrickletError>>,
timeout: Duration
) -> ConvertingReceiver<T>
[src]pub fn try_recv(&self) -> Result<T, BrickletTryRecvError>
[src]
pub fn try_recv(&self) -> Result<T, BrickletTryRecvError>
[src]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.
pub fn recv(&self) -> Result<T, BrickletRecvTimeoutError>
[src]
pub fn recv(&self) -> Result<T, BrickletRecvTimeoutError>
[src]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.
pub fn iter(&self) -> Iter<'_, T>ⓘNotable traits for Iter<'a, T>
impl<'a, T: FromByteSlice> Iterator for Iter<'a, T> type Item = T;
[src]
Notable traits for Iter<'a, T>
impl<'a, T: FromByteSlice> Iterator for Iter<'a, T> type Item = T;
pub fn try_iter(&self) -> TryIter<'_, T>ⓘNotable traits for TryIter<'a, T>
impl<'a, T: FromByteSlice> Iterator for TryIter<'a, T> type Item = T;
[src]
Notable traits for TryIter<'a, T>
impl<'a, T: FromByteSlice> Iterator for TryIter<'a, T> type Item = T;
Trait Implementations
impl<'a, T: FromByteSlice> IntoIterator for &'a ConvertingReceiver<T>
[src]
impl<'a, T: FromByteSlice> IntoIterator for &'a ConvertingReceiver<T>
[src]type Item = T
type Item = T
The type of the elements being iterated over.
impl<T: FromByteSlice> IntoIterator for ConvertingReceiver<T>
[src]
impl<T: FromByteSlice> IntoIterator for ConvertingReceiver<T>
[src]type Item = T
type Item = T
The type of the elements being iterated over.
Auto Trait Implementations
impl<T> !RefUnwindSafe for ConvertingReceiver<T>
impl<T> Send for ConvertingReceiver<T> where
T: Send,
T: Send,
impl<T> !Sync for ConvertingReceiver<T>
impl<T> Unpin for ConvertingReceiver<T> where
T: Unpin,
T: Unpin,
impl<T> !UnwindSafe for ConvertingReceiver<T>
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self