newAM
commented
3 years ago For the errors I was thinking something like this:
use std::error::Error;
use std::fmt;
use std::io;
// might not be possible to do this without GATs
// will have to use the expanded result if this doesn't work yet.
pub type Result<T, E> = std::result::Result<T, FtHalError<E>>;
#[derive(Debug)]
pub enum FtHalError<E: Error> {
HAL(ErrorKind),
Io(io::Error),
Backend(E),
}
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ErrorKind {
InvalidParams,
InvalidClock,
BusBusy,
I2cNoAck,
GpioPinBusy,
GpioInvalidPin,
SpiModeNotSupported,
}
impl ErrorKind {
fn as_str(&self) -> &str {
match *self {
ErrorKind::InvalidParams => "Invalid input params",
ErrorKind::BusBusy => "Bus is busy",
ErrorKind::InvalidClock => "Clock is not valid",
ErrorKind::I2cNoAck => "No ACK from slave",
ErrorKind::GpioPinBusy => "GPIO pin is already in use",
ErrorKind::GpioInvalidPin => "No such GPIO pin",
ErrorKind::SpiModeNotSupported => "Mode not supported",
}
}
}
impl<E: Error> fmt::Display for FtHalError<E> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
FtHalError::Io(err) => err.fmt(f),
FtHalError::Backend(err) => err.fmt(f),
FtHalError::HAL(err) => write!(f, "A regular error occurred {:?}", err.as_str()),
}
}
}
impl<E: Error> From<io::Error> for FtHalError<E> {
fn from(e: io::Error) -> Self {
FtHalError::Io(e)
}
}
#[cfg(feature = "ftdi")]
impl From<ftdi::Error> for FtHalError<ftdi::Error> {
fn from(e: ftdi::Error) -> Self {
FtHalError::Backend(e)
}
}
#[cfg(feature = "libftd2xx")]
impl From<libftd2xx::TimeoutError> for FtHalError<libftd2xx::TimeoutError> {
fn from(e: libftd2xx::TimeoutError) -> Self {
FtHalError::Backend(e)
}
}
This way both FtHalError<ftdi::Error> and FtHalError<libftd2xx::TimeoutError> types can be enabled/disabled independently.
Thoughts?
geomatsi
Hi @newAM
Work had me busy this week, so this PR is still a WIP that needs a lot of cleanup. On the other hand, overall approach is already shaping up. So it is a good time to get feedback before proceeding with cleanup. By the way, new examples work fine with both
libftd2xxandftdi-rsbackends.Here are some highlights:
libftd2xx-rsin use: current master https://github.com/ftdi-rs/libftd2xx, we haven't yet pushed new release with ftdi-mpsse supportftdi-rsin use: common-ftdimpsse development branch, not yet submitted for reviewObvious things that need to be modified during cleanup:
Thoughts ? Comments ? Concerns ?
Regards, Sergey