embedded-interfaces 0.10.3

Traits for common embedded interfaces and procedural macros for effortless definition of registers and commands for embedded device drivers
Documentation 
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

//! A comprehensive framework for building type-safe and ergonomic embedded device drivers.
//!
#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))]
#![cfg_attr(not(feature = "std"), no_std)]
#[cfg(not(any(feature = "sync", feature = "async")))]
compile_error!("You must enable at least one of the create features `sync` or `async`");

// Re-exports for codegen macro
pub use bitvec;
pub use bytemuck;
pub use const_format;

pub mod bitdump;
pub mod commands;
pub mod i2c;
pub mod packable;
pub mod registers;
pub mod spi;

/// A combined error type for Codec or Bus errors
#[derive(Debug, thiserror::Error)]
pub enum TransportError<CodecError, BusError> {
    /// The codec failed to encode or decode something
    #[error("codec error")]
    Codec(CodecError),
    /// An unexpected error
    #[error("unexpected: {0}")]
    Unexpected(&'static str),
    /// An error ocurred on the underlying interface
    #[error("bus error")]
    Bus(#[from] BusError),
}

/// Objects that implement this trait can produce a pretty-printed bit-dump of it's internal
/// structure.
#[cfg(feature = "std")]
pub trait BitdumpFormattable {
    /// Returns a bitdump formatter for the current object.
    fn bitdump(&self) -> bitdump::BitdumpFormatter;
}

#[cfg(feature = "std")]
impl BitdumpFormattable for () {
    fn bitdump(&self) -> bitdump::BitdumpFormatter {
        bitdump::BitdumpFormatter::new("()".to_string(), vec![], vec![])
    }
}

#[cfg(feature = "std")]
/// A helper trait that conditionally binds to BitdumpFormattable depending on whether the
/// necessary feature "std" is enabled.
pub trait MaybeBitdumpFormattable: crate::BitdumpFormattable {}

#[cfg(feature = "std")]
// Blanket impl
impl<T: crate::BitdumpFormattable> MaybeBitdumpFormattable for T {}

#[cfg(not(feature = "std"))]
/// A helper trait that conditionally binds to BitdumpFormattable depending on whether the
/// necessary feature "std" is enabled.
pub trait MaybeBitdumpFormattable {}

#[cfg(not(feature = "std"))]
// Blanket impl
impl<T> MaybeBitdumpFormattable for T {}

pub mod codegen {
    // re-export the derive stuff
    pub use embedded_interfaces_codegen::*;
}