Renamed "Interface" to "Channel" and replaced demonstatory "BytesRead…

…er" with just comments
tock · Jan 10, 2024 · c44f626 · c44f626
1 parent baafd01
commit c44f626
Show file tree

Hide file tree

Showing 11 changed files with 22 additions and 54 deletions.
diff --git a/src/interfaces.rs b/src/interfaces.rs
@@ -1,4 +1,4 @@
-use self::{jlink::JLinkInterface, openocd::OpenOCDInterface, serial::SerialInterface, traits::*};
+use self::{jlink::JLinkChannel, openocd::OpenOCDChannel, serial::SerialChannel, traits::*};
 use crate::errors::TockloaderError;
 use enum_dispatch::enum_dispatch;
 
@@ -7,10 +7,11 @@ pub mod openocd;
 pub mod serial;
 pub mod traits;
 
-#[enum_dispatch(BoardInterface)]
-#[enum_dispatch(BytesReader)]
-pub enum Interface {
-    Serial(SerialInterface),
-    OpenOCD(OpenOCDInterface),
-    JLink(JLinkInterface),
+#[enum_dispatch(BoardChannel)]
+// To add other traits, just chaing the enum_dispatch directive:
+// #[enum_dispatch(AnotherTrait)]
+pub enum Channel {
+    Serial(SerialChannel),
+    OpenOCD(OpenOCDChannel),
+    JLink(JLinkChannel),
 }
diff --git a/src/interfaces/jlink.rs b/src/interfaces/jlink.rs
@@ -1,4 +1,3 @@
 pub mod board_interface;
-pub mod bytes_reader;
 
-pub struct JLinkInterface {}
+pub struct JLinkChannel {}
diff --git a/src/interfaces/jlink/board_interface.rs b/src/interfaces/jlink/board_interface.rs
@@ -1,8 +1,8 @@
 use crate::errors::TockloaderError;
-use crate::interfaces::traits::BoardInterface;
-use crate::interfaces::JLinkInterface;
+use crate::interfaces::traits::BoardChannel;
+use crate::interfaces::JLinkChannel;
 
-impl BoardInterface for JLinkInterface {
+impl BoardChannel for JLinkChannel {
     fn open(&mut self) -> Result<(), TockloaderError> {
         todo!()
     }

diff --git a/src/interfaces/jlink/bytes_reader.rs b/src/interfaces/jlink/bytes_reader.rs
diff --git a/src/interfaces/openocd.rs b/src/interfaces/openocd.rs
@@ -1,4 +1,3 @@
 pub mod board_interface;
-pub mod bytes_reader;
 
-pub struct OpenOCDInterface {}
+pub struct OpenOCDChannel {}
diff --git a/src/interfaces/openocd/board_interface.rs b/src/interfaces/openocd/board_interface.rs
@@ -1,8 +1,8 @@
 use crate::errors::TockloaderError;
-use crate::interfaces::traits::BoardInterface;
-use crate::interfaces::OpenOCDInterface;
+use crate::interfaces::traits::BoardChannel;
+use crate::interfaces::OpenOCDChannel;
 
-impl BoardInterface for OpenOCDInterface {
+impl BoardChannel for OpenOCDChannel {
     fn open(&mut self) -> Result<(), TockloaderError> {
         todo!()
     }

diff --git a/src/interfaces/openocd/bytes_reader.rs b/src/interfaces/openocd/bytes_reader.rs
diff --git a/src/interfaces/serial.rs b/src/interfaces/serial.rs
@@ -1,4 +1,3 @@
 pub mod board_interface;
-pub mod bytes_reader;
 
-pub struct SerialInterface {}
+pub struct SerialChannel {}
diff --git a/src/interfaces/serial/board_interface.rs b/src/interfaces/serial/board_interface.rs
@@ -1,8 +1,8 @@
 use crate::errors::TockloaderError;
-use crate::interfaces::traits::BoardInterface;
-use crate::interfaces::SerialInterface;
+use crate::interfaces::traits::BoardChannel;
+use crate::interfaces::SerialChannel;
 
-impl BoardInterface for SerialInterface {
+impl BoardChannel for SerialChannel {
     fn open(&mut self) -> Result<(), TockloaderError> {
         todo!()
     }

diff --git a/src/interfaces/serial/bytes_reader.rs b/src/interfaces/serial/bytes_reader.rs
diff --git a/src/interfaces/traits.rs b/src/interfaces/traits.rs
@@ -2,11 +2,8 @@ use crate::errors::TockloaderError;
 use enum_dispatch::enum_dispatch;
 
 #[enum_dispatch]
-pub trait BoardInterface {
+pub trait BoardChannel {
     fn open(&mut self) -> Result<(), TockloaderError>;
 }
 
-#[enum_dispatch]
-pub trait BytesReader {
-    fn read_range(&self, start: usize, len: usize) -> Result<Vec<u8>, TockloaderError>;
-}
+// Other traits go in here