Change to alloc feature

Author: ejka-inapril

Cargo.lock

@@ -14,13 +14,15 @@ edition = "2021"
 all-features = true
 
 [features]
-default = []
+default = ["heapless", "xmodem", "ymodem", "zmodem"]
 xmodem = []
 ymodem = []
 zmodem = []
+alloc = []
 
 [dependencies]
 core2 = { version = "0.4.0", default-features = false }
 crc16 = "0.4.0"
 thiserror-no-std = "2.0.2"
 anyhow = { version = "1.0.75", default-features = false }
+heapless = { version = "0.8.0", optional = true }

Cargo.toml

@@ -1,9 +1,12 @@
 #![allow(dead_code)]
 
+#[cfg(feature = "alloc")]
 extern crate alloc;
 
-use alloc::boxed::Box;
+#[cfg(feature = "alloc")]
 use alloc::string::String;
+#[cfg(not(feature = "alloc"))]
+use heapless::String;
 
 use anyhow::Result;
 use core2::io::{Error, Read, Write};
@@ -34,7 +37,7 @@ pub enum ModemError {
     /// The number of communications errors exceeded `max_errors` in a single
     /// transmission.
     #[error("Too many errors, aborting - max errors: {errors}")]
-    ExhaustedRetries { errors: Box<u32> },
+    ExhaustedRetries { errors: u32 },
 
     /// The transmission was canceled by the other end of the channel.
     #[error("Cancelled by the other party.")]
@@ -142,14 +145,16 @@ pub trait YModemTrait: ModemTrait {
         &mut self,
         dev: &mut D,
         out: &mut W,
-        file_name: &mut String,
+        #[cfg(feature = "alloc")] file_name: &mut String,
+        #[cfg(not(feature = "alloc"))] file_name: &mut String<128>,
         file_size: &mut u32,
     ) -> ModemResult<()>;
     fn send<D: Read + Write, R: Read>(
         &mut self,
         dev: &mut D,
         inp: &mut R,
-        file_name: String,
+        #[cfg(feature = "alloc")] file_name: String,
+        #[cfg(not(feature = "alloc"))] file_name: String<128>,
         file_size: u64,
     ) -> ModemResult<()>;
     fn send_stream<D: Read + Write, R: Read>(
@@ -162,7 +167,8 @@ pub trait YModemTrait: ModemTrait {
     fn send_start_frame<D: Read + Write>(
         &mut self,
         dev: &mut D,
-        file_name: String,
+        #[cfg(feature = "alloc")] file_name: String,
+        #[cfg(not(feature = "alloc"))] file_name: String<128>,
         file_size: u64,
     ) -> ModemResult<()>;
     fn send_end_frame<D: Read + Write>(

src/common.rs

@@ -16,6 +16,7 @@
     variant_size_differences
 )]
 
+#[cfg(feature = "alloc")]
 extern crate alloc;
 
 mod common;

src/lib.rs

@@ -1,11 +1,13 @@
-use alloc::{boxed::Box, vec, vec::Vec};
-use core::convert::From;
-
 use crate::common::{
     calc_checksum, calc_crc, get_byte, get_byte_timeout, ModemError,
     ModemResult, ModemTrait, XModemTrait,
 };
+#[cfg(feature = "alloc")]
+use alloc::{vec, vec::Vec};
+use core::convert::From;
 use core2::io::{Read, Write};
+#[cfg(not(feature = "alloc"))]
+use heapless::Vec;
 
 use crate::variants::xmodem::{
     common::{BlockLengthKind, ChecksumKind},
@@ -101,8 +103,14 @@ impl XModemTrait for XModem {
                                                   // We'll respond with cancel later if the packet number is wrong
                     let cancel_packet =
                         packet_num != pnum || (255 - pnum) != pnum_1c;
+                    #[cfg(feature = "alloc")]
                     let mut data: Vec<u8> = Vec::new();
+                    #[cfg(not(feature = "alloc"))]
+                    let mut data: Vec<u8, 1024> = Vec::new();
+                    #[cfg(feature = "alloc")]
                     data.resize(packet_size, 0);
+                    #[cfg(not(feature = "alloc"))]
+                    data.resize(packet_size, 0).unwrap_or_default();
                     dev.read_exact(&mut data)?;
                     let success = match self.checksum_mode {
                         ChecksumKind::Standard => {
@@ -144,7 +152,7 @@ impl XModemTrait for XModem {
             if self.errors >= self.max_errors {
                 dev.write_all(&[Consts::CAN.into()])?;
                 return Err(ModemError::ExhaustedRetries {
-                    errors: Box::from(self.errors),
+                    errors: self.errors,
                 });
             }
         }
@@ -183,7 +191,7 @@ impl XModemTrait for XModem {
             if self.errors >= self.max_errors {
                 // FIXME: Removed a unused 'if let' here. To be re-added?
                 return Err(ModemError::ExhaustedRetries {
-                    errors: Box::from(self.errors),
+                    errors: self.errors,
                 });
             }
         }
@@ -208,7 +216,7 @@ impl XModemTrait for XModem {
 
             if self.errors >= self.max_errors {
                 return Err(ModemError::ExhaustedRetries {
-                    errors: Box::from(self.errors),
+                    errors: self.errors,
                 });
             }
         }
@@ -221,7 +229,16 @@ impl XModemTrait for XModem {
     {
         let mut block_num = 0u32;
         loop {
+            #[cfg(feature = "alloc")]
             let mut buff = vec![self.pad_byte; self.block_length as usize + 3];
+            #[cfg(not(feature = "alloc"))]
+            let mut buff: Vec<u8, 1029> = Vec::new();
+            #[cfg(not(feature = "alloc"))]
+            buff.resize(self.block_length as usize + 3, self.pad_byte)
+                .unwrap_or_default();
+
+            #[cfg(feature = "alloc")]
+            buff.resize(self.block_length as usize + 3, self.pad_byte);
             let n = inp.read(&mut buff[3..])?;
             if n == 0 {
                 return Ok(());
@@ -238,12 +255,21 @@ impl XModemTrait for XModem {
             match self.checksum_mode {
                 ChecksumKind::Standard => {
                     let checksum = calc_checksum(&buff[3..]);
+                    #[cfg(feature = "alloc")]
                     buff.push(checksum);
+                    #[cfg(not(feature = "alloc"))]
+                    buff.push(checksum).unwrap_or_default();
                 }
                 ChecksumKind::Crc16 => {
                     let crc = calc_crc(&buff[3..]);
+                    #[cfg(feature = "alloc")]
                     buff.push(((crc >> 8) & 0xFF) as u8);
+                    #[cfg(feature = "alloc")]
                     buff.push((&crc & 0xFF) as u8);
+                    #[cfg(not(feature = "alloc"))]
+                    buff.push(((crc >> 8) & 0xFF) as u8).unwrap_or_default();
+                    #[cfg(not(feature = "alloc"))]
+                    buff.push((&crc & 0xFF) as u8).unwrap_or_default();
                 }
             }
 
@@ -260,7 +286,7 @@ impl XModemTrait for XModem {
 
             if self.errors >= self.max_errors {
                 return Err(ModemError::ExhaustedRetries {
-                    errors: Box::from(self.errors),
+                    errors: self.errors,
                 });
             }
         }