Merge pull request #33 from Jim-Hodapp-Coaching/refine_module_privacy

Tighten scope of modules, enums, structs and trait symbols across the entire crate

Author: jhodapp

esp32-wroom-rp/src/protocol.rs

@@ -10,14 +10,14 @@ pub const MAX_NINA_PARAM_LENGTH: usize = 255;
 
 #[repr(u8)]
 #[derive(Copy, Clone, Debug)]
-pub enum NinaCommand {
+pub(crate) enum NinaCommand {
     GetFwVersion = 0x37u8,
     SetPassphrase = 0x11u8,
     GetConnStatus = 0x20u8,
     Disconnect = 0x30u8,
 }
 
-pub trait NinaParam {
+pub(crate) trait NinaParam {
     // Length of parameter in bytes
     type LengthAsBytes: IntoIterator<Item = u8>;
 
@@ -33,7 +33,7 @@ pub trait NinaParam {
 }
 
 // Used for Nina protocol commands with no parameters
-pub struct NinaNoParams {
+pub(crate) struct NinaNoParams {
     _placeholder: u8,
 }
 
@@ -62,25 +62,25 @@ impl NinaParam for NinaNoParams {
 }
 
 // Used for single byte params
-pub struct NinaByteParam {
+pub(crate) struct NinaByteParam {
     length: u8,
     data: Vec<u8, 1>,
 }
 
 // Used for 2-byte params
-pub struct NinaWordParam {
+pub(crate) struct NinaWordParam {
     length: u8,
     data: Vec<u8, 2>,
 }
 
 // Used for params that are smaller than 255 bytes
-pub struct NinaSmallArrayParam {
+pub(crate) struct NinaSmallArrayParam {
     length: u8,
     data: Vec<u8, MAX_NINA_PARAM_LENGTH>,
 }
 
 // Used for params that can be larger than 255 bytes up to MAX_NINA_PARAM_LENGTH
-pub struct NinaLargeArrayParam {
+pub(crate) struct NinaLargeArrayParam {
     length: u16,
     data: Vec<u8, MAX_NINA_PARAM_LENGTH>,
 }
@@ -220,7 +220,7 @@ impl NinaParam for NinaLargeArrayParam {
     }
 }
 
-pub trait ProtocolInterface {
+pub(crate) trait ProtocolInterface {
     fn init(&mut self);
     fn reset<D: DelayMs<u16>>(&mut self, delay: &mut D);
     fn get_fw_version(&mut self) -> Result<FirmwareVersion, self::Error>;
@@ -230,7 +230,7 @@ pub trait ProtocolInterface {
 }
 
 #[derive(Debug, Default)]
-pub struct NinaProtocolHandler<B, C> {
+pub(crate) struct NinaProtocolHandler<B, C> {
     /// A Spi or I2c instance
     pub bus: B,
     /// An EspControlPins instance

esp32-wroom-rp/src/protocol/operation.rs

@@ -6,7 +6,7 @@ const MAX_NUMBER_OF_PARAMS: usize = 4;
 // Encapsulates all information needed to execute commands against Nina Firmware.
 // along with user supplied data. Ex. SSID, passphrase, etc.
 
-pub struct Operation<P> {
+pub(crate) struct Operation<P> {
     pub params: Vec<P, MAX_NUMBER_OF_PARAMS>,
     pub command: NinaCommand,
     pub has_params: bool,