embedded-error

用于嵌入式系统的通用特定错误类型集合

什么是 embedded-error？

embedded-error 应运而生，以满足在嵌入式系统上运行的应用程序对通用但特定的“错误”类型的需求。

与在服务器或桌面电脑上运行的常规应用程序不同，嵌入式系统通常没有用户或监控其输出的管理进程；大多数系统甚至没有可以用来显示错误的显示屏。相反，应用程序必须能够识别任何已发出的错误，以便适当地处理它们。

还需要注意的是，许多错误类型并不是致命的，而是用来在外围设备或连接到外围设备的应用程序之间进行通信的一种方式。因此，通常没有必要将 Err 情况视为全面致命的事件，停止或重启应用程序，这在无法区分错误类型的情况下可能是这种情况，例如，因为错误类型是特定实现的且不适用于不同的硬件。

embedded-error 致力于收集所有可能的错误类型，按照外围设备进行分组，并将它们作为 non-exhaustive 枚举提供，类似于 std::io::ErrorKind 所做的那样。

这允许驱动程序使用定义良好的错误类型，以及应用程序和通用驱动程序可以通用地处理典型的“错误”。

如何使用 embedded-error

使用方法简单明了

1. 在您的 Cargo.toml 中声明对 embedded-error 的使用

embedded-error = "*"

2. 如果您是 embedded-hal 特性的实现者，请在您的实现中定义适当的 error 作为关联的 Error 类型，例如。

impl WriteRead for I2c
{
    type Error = embedded_error::I2cError;
    ...

3. 如果您正在实现一个独立的驱动程序或函数，只需在 Result 中使用它即可，例如：

pub fn new(spi: &mut SPI) -> Result<Self, embedded_error::SpiError>

并通过 ? 操作符返回或传递适当的错误。4. 作为（嵌入式）应用程序编写者，要处理错误，您只需匹配它。请注意，由于错误声明为 non_exhaustive，您将始终需要与通配符匹配以处理未来添加的未处理或错误情况。Rust 编译器会告诉您是否操作不当。下面是一个例子：

use embedded_error::I2cError;

match i2c.write(addr, &[]) {
        Err(I2cError::NACK) => { writeln!(out, "No device on address {}", addr).ok(); },
        Ok(_) => { writeln!(out, "Found device on address {}", addr).ok(); },
        _ => { writeln!(out, "Ohoh, the device is on fire, let's reboot".ok(); reboot(); },
}