feat: Add integration with schemars

Integrate with `schemars`, which allows to generate a JSON schema for a `serde` generated JSON file.

A v1 of `schemars` is in the works, but that will take some months. It seems the derive API will not change.

Author: caspermeijn

Cargo.toml

@@ -47,6 +47,7 @@ features = [
 cfg-if = "1.0.0"
 scopeguard = "1.1"
 serde = { version = "1.0", features = ["derive"], optional = true }
+schemars = { package = "schemars", version = "0.8", features = ["derive"], optional = true }
 
 [dev-dependencies]
 assert_hex = "0.4.1"

src/lib.rs

@@ -139,6 +139,7 @@ impl From<Error> for io::Error {
 /// Number of bits per character
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub enum DataBits {
     /// 5 bits per character
     Five,
@@ -200,6 +201,7 @@ impl TryFrom<u8> for DataBits {
 /// transmitted.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub enum Parity {
     /// No parity bit.
     None,
@@ -226,6 +228,7 @@ impl fmt::Display for Parity {
 /// Stop bits are transmitted after every character.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub enum StopBits {
     /// One stop bit.
     One,
@@ -267,6 +270,7 @@ impl TryFrom<u8> for StopBits {
 /// Flow control modes
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub enum FlowControl {
     /// No flow control.
     None,
@@ -306,6 +310,7 @@ impl FromStr for FlowControl {
 /// [`clear`]: trait.SerialPort.html#tymethod.clear
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub enum ClearBuffer {
     /// Specify to clear data received but not read
     Input,
@@ -799,6 +804,7 @@ impl fmt::Debug for dyn SerialPort {
 /// Contains all possible USB information about a `SerialPort`
 #[derive(Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub struct UsbPortInfo {
     /// Vendor ID
     pub vid: u16,
@@ -840,6 +846,7 @@ impl std::fmt::Debug for UsbPortInfo {
 /// The physical type of a `SerialPort`
 #[derive(Debug, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub enum SerialPortType {
     /// The serial port is connected via USB
     UsbPort(UsbPortInfo),
@@ -854,6 +861,7 @@ pub enum SerialPortType {
 /// A device-independent implementation of serial port information
 #[derive(Debug, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub struct SerialPortInfo {
     /// The short name of the serial port
     pub port_name: String,