Support serde in question (#29)

* support serde in question

* add Note to readme

* wording

crates/jlabel-question/Cargo.toml

@@ -18,10 +18,12 @@ rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
 regex = ["dep:regex-automata", "dep:regex-syntax"]
+serde = ["dep:serde"]
 
 [dependencies]
 jlabel.workspace = true
 thiserror.workspace = true
 
 regex-automata = { version = "0.4.4", optional = true }
 regex-syntax = { version = "0.8.2", optional = true }
+serde = { version = "1", features = ["derive"], optional = true }

crates/jlabel-question/README.md

@@ -2,6 +2,8 @@
 
 Parser and matcher of htsvoice full-context-label questions.
 
+**Note: `serde` support is experimental. Changes may not be treated as breaking.**
+
 ## Usage
 
 Put the following in Cargo.toml

crates/jlabel-question/src/lib.rs

@@ -106,6 +106,9 @@ use position::{
 use jlabel::Label;
 use parse_position::{estimate_position, PositionError};
 
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+
 /// Errors from jlabel-question.
 #[derive(Debug, Clone, thiserror::Error, PartialEq, Eq)]
 pub enum ParseError {
@@ -173,6 +176,7 @@ where
 
 /// A main structure representing question.
 #[derive(Debug, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub enum AllQuestion {
     /// Question about phone fields of full-context label
     Phone(Question<PhonePosition>),
@@ -236,10 +240,18 @@ impl QuestionMatcher for AllQuestion {
 ///
 /// Used in variants of [`AllQuestion`]
 #[derive(Debug, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct Question<P: Position> {
     /// The position this question matches to.
     pub position: P,
     /// The parsed range
+    #[cfg_attr(
+        feature = "serde",
+        serde(bound(
+            serialize = "P::Range: Serialize",
+            deserialize = "P::Range: Deserialize<'de>"
+        ))
+    )]
     pub range: Option<P::Range>,
 }
 

crates/jlabel-question/src/position.rs

@@ -6,6 +6,9 @@ use crate::Label;
 
 use super::ParseError;
 
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+
 /// Enum that represent all positions
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum AllPosition {
@@ -52,6 +55,7 @@ pub trait Position {
 
 /// Positions of phone fields
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[allow(missing_docs)]
 pub enum PhonePosition {
     P1,
@@ -86,6 +90,7 @@ impl Position for PhonePosition {
 
 /// Positions with signed integer type
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[allow(missing_docs)]
 pub enum SignedRangePosition {
     A1,
@@ -133,6 +138,7 @@ fn range_i8<S: AsRef<str>>(s: S) -> Result<Range<i8>, ParseError> {
 
 /// Positions with unsigned integer type
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[allow(missing_docs)]
 pub enum UnsignedRangePosition {
     A2,
@@ -256,6 +262,7 @@ where
 
 /// Positions with boolean type
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[allow(missing_docs)]
 pub enum BooleanPosition {
     E3,
@@ -299,6 +306,7 @@ impl Position for BooleanPosition {
 
 /// Positions with numerical representations of categorical value
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[allow(missing_docs)]
 pub enum CategoryPosition {
     B1,
@@ -344,6 +352,7 @@ impl Position for CategoryPosition {
 
 /// Positions that are always `xx`
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[allow(missing_docs)]
 pub enum UndefinedPotision {
     E4,