add async API

Author: liamkinne

embedded-can/src/asynch.rs

@@ -0,0 +1,25 @@
+//! Async CAN API
+
+/// An async CAN interface that is able to transmit and receive frames.
+pub trait Can {
+    /// Associated frame type.
+    type Frame: crate::Frame;
+
+    /// Associated error type.
+    type Error: crate::Error;
+
+    /// Puts a frame in the transmit buffer.
+    /// Awaits until space is available in the transmit buffer.
+    async fn transmit(&mut self, frame: &Self::Frame) -> Result<(), Self::Error>;
+
+    /// Tries to put a frame in the transmit buffer.
+    /// If no space is available in the transmit buffer `None` is returned.
+    fn try_transmit(&mut self, frame: &Self::Frame) -> Option<Result<(), Self::Error>>;
+
+    /// Awaits until a frame was received or an error occurred.
+    async fn receive(&mut self) -> Result<Self::Frame, Self::Error>;
+
+    /// Tries to receive a frame from the receive buffer.
+    /// If no frame is available `None` is returned.
+    fn try_receive(&mut self) -> Option<Result<Self::Frame, Self::Error>>;
+}

embedded-can/src/lib.rs

@@ -2,7 +2,9 @@
 
 #![warn(missing_docs)]
 #![no_std]
+#![allow(async_fn_in_trait)]
 
+pub mod asynch;
 pub mod blocking;
 pub mod nb;