1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
//! A wrapper for [`Receiver`](std::sync::mpsc::Receiver), which converts received byte vectors to structured data.
//! This variant of [`ConvertingReceiver`](crate::converting_receiver::ConvertingReceiver) is used for events.
use crate::byte_converter::FromByteSlice;
use std::{error::Error, marker::PhantomData, sync::mpsc::*, time::Duration};
/// Error type which is returned if a [`recv_forever`](crate::converting_callback_receiver::ConvertingCallbackReceiver::recv_forever) call fails.
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum CallbackRecvError {
/// The queue was disconnected. This usually happens if the ip connection is destroyed.
QueueDisconnected,
/// The received packet had an unexpected length. Maybe a function was called on a wrong brick or bricklet?
MalformedPacket,
}
impl std::fmt::Display for CallbackRecvError {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { write!(f, "{}", self.description()) }
}
impl std::error::Error for CallbackRecvError {
fn description(&self) -> &str {
match self {
CallbackRecvError::QueueDisconnected => "The queue was disconnected. This usually happens if the ip connection is destroyed.",
CallbackRecvError::MalformedPacket =>
"The received packet had an unexpected length. Maybe a function was called on a wrong brick or bricklet?",
}
}
}
/// Error type which is returned if a [`recv_timeout`](crate::converting_callback_receiver::ConvertingCallbackReceiver::recv_timeout) call fails.
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum CallbackRecvTimeoutError {
/// The queue was disconnected. This usually happens if the ip connection is destroyed.
QueueDisconnected,
/// The request could not be responded to before the timeout was reached.
QueueTimeout,
/// The received packet had an unexpected length. Maybe a function was called on a wrong brick or bricklet?
MalformedPacket,
}
impl std::fmt::Display for CallbackRecvTimeoutError {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { write!(f, "{}", self.description()) }
}
impl std::error::Error for CallbackRecvTimeoutError {
fn description(&self) -> &str {
match self {
CallbackRecvTimeoutError::QueueDisconnected =>
"The queue was disconnected. This usually happens if the ip connection is destroyed.",
CallbackRecvTimeoutError::QueueTimeout => "The request could not be responded to before the timeout was reached.",
CallbackRecvTimeoutError::MalformedPacket =>
"The received packet had an unexpected length. Maybe a function was called on a wrong brick or bricklet?",
}
}
}
/// Error type which is returned if a [`try_recv`](crate::converting_callback_receiver::ConvertingCallbackReceiver::try_recv) call fails.
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum CallbackTryRecvError {
/// The queue was disconnected. This usually happens if the ip connection is destroyed.
QueueDisconnected,
/// There are currently no responses available.
QueueEmpty,
/// The received packet had an unexpected length. Maybe a function was called on a wrong brick or bricklet?
MalformedPacket,
}
impl std::fmt::Display for CallbackTryRecvError {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { write!(f, "{}", self.description()) }
}
impl std::error::Error for CallbackTryRecvError {
fn description(&self) -> &str {
match self {
CallbackTryRecvError::QueueDisconnected =>
"The queue was disconnected. This usually happens if the ip connection is destroyed.",
CallbackTryRecvError::QueueEmpty => "There are currently no responses available.",
CallbackTryRecvError::MalformedPacket =>
"The received packet had an unexpected length. Maybe a function was called on a wrong brick or bricklet?",
}
}
}
/// A wrapper for [`Receiver`], which converts received byte vectors to structured data. This variant of
/// [`ConvertingReceiver`](crate::converting_receiver::ConvertingReceiver) is used for events.
///
/// This receiver wraps a [`Receiver`] receiving raw bytes. Calling [`recv_forever`], [`recv_timeout`] or [`try_recv`]
/// will call equivalent methods on the wrapped [`Receiver`] and then convert the received bytes
/// to a instance of `T`.
///
///
/// # Type parameters
///
/// * `T` - Type which is created from received byte vectors. Must implement [`FromByteSlice`](crate::byte_converter::FromByteSlice)
///
/// # Errors
///
/// Returned errors are equivalent to those returned from methods of a [`Receiver`].
/// If the received response can not be interpreted as the result type `T`, a `MalformedPacket`
/// error is raised.
///
/// [`Receiver`]: std::sync::mpsc::Receiver
/// [`recv_forever`]: #method.recv_forever
/// [`recv_timeout`]: #method.recv_timeout
/// [`try_recv`]: #method.try_recv
pub struct ConvertingCallbackReceiver<T: FromByteSlice> {
receiver: Receiver<Vec<u8>>,
phantom: PhantomData<T>,
}
impl<T: FromByteSlice> ConvertingCallbackReceiver<T> {
/// Creates a new converting callback receiver which wraps the given [`Receiver`](std::sync::mpsc::Receiver).
pub fn new(receiver: Receiver<Vec<u8>>) -> ConvertingCallbackReceiver<T> {
ConvertingCallbackReceiver { receiver, phantom: PhantomData }
}
/// Attempts to return a pending value on this receiver without blocking. This method behaves like [`try_recv`](std::sync::mpsc::Receiver::try_recv).
///
/// # Errors
///
/// Returns an error if the queue was disconnected or currently empty, or if the received packet was malformed.
pub fn try_recv(&self) -> Result<T, CallbackTryRecvError> {
let recv_result = self.receiver.try_recv();
match recv_result {
Ok(bytes) =>
if T::bytes_expected() == bytes.len() {
Ok(T::from_le_byte_slice(&bytes))
} else {
Err(CallbackTryRecvError::MalformedPacket)
},
Err(TryRecvError::Disconnected) => Err(CallbackTryRecvError::QueueDisconnected),
Err(TryRecvError::Empty) => Err(CallbackTryRecvError::QueueEmpty),
}
}
/// Attempts to wait for a value on this receiver, returning an error if the corresponding channel has hung up. This method behaves like [`recv`](std::sync::mpsc::Receiver::recv).
///
/// # Errors
///
/// Returns an error if the queue was disconnected or currently empty, or if the received packet was malformed.
pub fn recv_forever(&self) -> Result<T, CallbackRecvError> {
let recv_result = self.receiver.recv();
match recv_result {
Ok(bytes) =>
if T::bytes_expected() == bytes.len() {
Ok(T::from_le_byte_slice(&bytes))
} else {
Err(CallbackRecvError::MalformedPacket)
},
Err(RecvError) => Err(CallbackRecvError::QueueDisconnected),
}
}
/// 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`](std::sync::mpsc::Receiver::recv_timeout).
///
/// # Errors
///
/// Returns an error on one of the following conditions:
/// * The queue was disconnected.
/// * The received packet was malformed.
/// * Blocked longer than the configured time out.
pub fn recv_timeout(&self, timeout: Duration) -> Result<T, CallbackRecvTimeoutError> {
let recv_result = self.receiver.recv_timeout(timeout);
match recv_result {
Ok(bytes) =>
if T::bytes_expected() == bytes.len() {
Ok(T::from_le_byte_slice(&bytes))
} else {
Err(CallbackRecvTimeoutError::MalformedPacket)
},
Err(RecvTimeoutError::Disconnected) => Err(CallbackRecvTimeoutError::QueueDisconnected),
Err(RecvTimeoutError::Timeout) => Err(CallbackRecvTimeoutError::QueueTimeout),
}
}
/* uncomment if https://github.com/rust-lang/rust/issues/46316 has landed
pub fn recv_deadline(&self, deadline: Instant) -> Result<T, RecvTimeoutError> {
let bytes = self.receiver.recv_deadline(deadline)?;
Ok(T::from_le_byte_slice(bytes))
}
*/
pub fn iter(&self) -> Iter<T> { Iter { rx: self } }
pub fn try_iter(&self) -> TryIter<T> { TryIter { rx: self } }
}
pub struct Iter<'a, T: 'a + FromByteSlice> {
rx: &'a ConvertingCallbackReceiver<T>,
}
pub struct TryIter<'a, T: 'a + FromByteSlice> {
rx: &'a ConvertingCallbackReceiver<T>,
}
pub struct IntoIter<T: FromByteSlice> {
rx: ConvertingCallbackReceiver<T>,
}
impl<'a, T: FromByteSlice> Iterator for Iter<'a, T> {
type Item = T;
fn next(&mut self) -> Option<T> { self.rx.recv_forever().ok() }
}
impl<'a, T: FromByteSlice> Iterator for TryIter<'a, T> {
type Item = T;
fn next(&mut self) -> Option<T> { self.rx.try_recv().ok() }
}
impl<'a, T: FromByteSlice> IntoIterator for &'a ConvertingCallbackReceiver<T> {
type Item = T;
type IntoIter = Iter<'a, T>;
fn into_iter(self) -> Iter<'a, T> { self.iter() }
}
impl<T: FromByteSlice> Iterator for IntoIter<T> {
type Item = T;
fn next(&mut self) -> Option<T> { self.rx.recv_forever().ok() }
}
impl<T: FromByteSlice> IntoIterator for ConvertingCallbackReceiver<T> {
type Item = T;
type IntoIter = IntoIter<T>;
fn into_iter(self) -> IntoIter<T> { IntoIter { rx: self } }
}