Merge pull request #3 from sunsided/feature/corncobs

Add corncobs decoding

Cargo.toml

@@ -8,5 +8,6 @@ publish = false
 [dependencies]
 anyhow = "1.0.86"
 array_pool = "0.1.2"
+corncobs = "0.1.3"
 tokio = { version = "1.38.0", features = ["full"] }
 tokio-serial = "5.4.4"

src/main.rs

@@ -1,12 +1,17 @@
-use std::ops::Deref;
+extern crate core;
 use std::sync::Arc;
 use std::time::Duration;
 
-use array_pool::pool::{ArrayPool, BorrowingSlice};
+use array_pool::pool::ArrayPool;
+use corncobs::CobsError;
 use tokio::io::{self, AsyncBufReadExt, AsyncReadExt, AsyncWriteExt, BufReader};
 use tokio::sync::mpsc::{unbounded_channel, UnboundedReceiver, UnboundedSender};
 use tokio_serial::{DataBits, FlowControl, Parity, SerialPortBuilderExt, SerialStream, StopBits};
 
+use crate::packet::DataSlice;
+
+mod packet;
+
 #[tokio::main]
 async fn main() -> anyhow::Result<()> {
     let port_name = "/dev/ttyACM0";
@@ -22,7 +27,7 @@ async fn main() -> anyhow::Result<()> {
         .open_native_async()
         .expect("Failed to open port");
 
-    let (from_device, mut receiver) = unbounded_channel::<Packet>();
+    let (from_device, mut receiver) = unbounded_channel::<DataSlice>();
     let (command, to_device) = unbounded_channel::<String>();
 
     // Pool for sharing data
@@ -36,9 +41,23 @@ async fn main() -> anyhow::Result<()> {
 
     // Main loop for printing input from the serial line.
     loop {
-        if let Some(data) = receiver.recv().await {
-            let data = String::from_utf8_lossy(&data).into_owned();
-            print!("{}", data);
+        if let Some(mut data) = receiver.recv().await {
+            match corncobs::decode_in_place(&mut data) {
+                Ok(decoded_length) => {
+                    let data = String::from_utf8_lossy(&data[..decoded_length]);
+                    println!("Received data: {:?}", data);
+                }
+                Err(e) => {
+                    match e {
+                        CobsError::Truncated => {
+                            // ignored; this is a synchronization issue
+                        }
+                        CobsError::Corrupt => {
+                            // ignored
+                        }
+                    }
+                }
+            }
         }
     }
 }
@@ -58,7 +77,7 @@ async fn handle_std_input(command: UnboundedSender<String>) {
 
 async fn handle_data_recv(
     mut port: SerialStream,
-    from_device: UnboundedSender<Packet>,
+    from_device: UnboundedSender<DataSlice>,
     mut to_device: UnboundedReceiver<String>,
     pool: Arc<ArrayPool<u8>>,
 ) -> anyhow::Result<()> {
@@ -76,7 +95,7 @@ async fn handle_data_recv(
                     if bytes_read > 0 {
                         let mut slice = pool.rent(bytes_read).map_err(|_| anyhow::Error::msg("failed to borrow from pool"))?;
                         slice[..bytes_read].copy_from_slice(&buf[..bytes_read]);
-                        from_device.send(Packet::new(slice, bytes_read))?;
+                        from_device.send(DataSlice::new(slice, bytes_read))?;
                     }
                 }
                 Err(ref e) if e.kind() == io::ErrorKind::TimedOut => (),
@@ -85,28 +104,3 @@ async fn handle_data_recv(
         }
     }
 }
-
-struct Packet {
-    buffer: BorrowingSlice<u8>,
-    size: usize,
-}
-
-impl Packet {
-    pub fn new(buffer: BorrowingSlice<u8>, size: usize) -> Self {
-        Self { buffer, size }
-    }
-}
-
-impl AsRef<[u8]> for Packet {
-    fn as_ref(&self) -> &[u8] {
-        &self.buffer[..self.size]
-    }
-}
-
-impl Deref for Packet {
-    type Target = [u8];
-
-    fn deref(&self) -> &Self::Target {
-        self.as_ref()
-    }
-}

src/packet.rs

@@ -0,0 +1,52 @@
+use std::ops::{Deref, DerefMut};
+
+use array_pool::pool::BorrowingSlice;
+
+/// A slice of data transmitted over the wire.
+pub struct DataSlice {
+    buffer: BorrowingSlice<u8>,
+    size: usize,
+}
+
+impl DataSlice {
+    pub fn new(buffer: BorrowingSlice<u8>, size: usize) -> Self {
+        assert!(buffer.len() >= size);
+        Self { buffer, size }
+    }
+
+    #[allow(unused)]
+    pub fn len(&self) -> usize {
+        self.size
+    }
+
+    #[allow(unused)]
+    pub fn is_empty(&self) -> bool {
+        self.len() == 0
+    }
+}
+
+impl AsRef<[u8]> for DataSlice {
+    fn as_ref(&self) -> &[u8] {
+        &self.buffer[..self.size]
+    }
+}
+
+impl AsMut<[u8]> for DataSlice {
+    fn as_mut(&mut self) -> &mut [u8] {
+        &mut self.buffer[..self.size]
+    }
+}
+
+impl Deref for DataSlice {
+    type Target = [u8];
+
+    fn deref(&self) -> &Self::Target {
+        self.as_ref()
+    }
+}
+
+impl DerefMut for DataSlice {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        self.as_mut()
+    }
+}