Provide BuilderError through prelude

Also adds documentation strings to BuilderError

Author: ianrrees

CHANGELOG.md

@@ -8,7 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 
 ### Added
-* `LangID` in `prelude` and `class_prelude`, `StringDescriptors` in `prelude`
+* `BuilderError`, `LangID`, `StringDescriptors` now in `prelude`
+* `LangID` now in `class_prelude`
 
 ## [0.3.0] - 2023-11-13
 

src/device_builder.rs

@@ -24,9 +24,13 @@ macro_rules! builder_fields {
 }
 
 #[derive(Copy, Clone, Debug, PartialEq)]
+/// Error type for the USB device builder
 pub enum BuilderError {
+    /// String descriptors were provided in more languages than are supported
     TooManyLanguages,
+    /// Control endpoint can only be 8, 16, 32, or 64 byte max packet size
     InvalidPacketSize,
+    /// Configuration specifies higher USB power draw than allowed
     PowerTooHigh,
 }
 

src/lib.rs

@@ -185,6 +185,7 @@ pub mod prelude {
     pub use crate::device::{
         StringDescriptors, UsbDevice, UsbDeviceBuilder, UsbDeviceState, UsbVidPid,
     };
+    pub use crate::device_builder::BuilderError;
     pub use crate::LangID;
     pub use crate::UsbError;
 }