Add more documentation

anthok · Jul 18, 2021 · fb424b8 · fb424b8
1 parent 41b16ec
commit fb424b8
Show file tree

Hide file tree

Showing 13 changed files with 670 additions and 355 deletions.
diff --git a/macros/src/decode.rs b/macros/src/decode.rs
@@ -112,8 +112,10 @@ pub fn derive_enum_impl(
 
         }
     } else {
+        let error = crate::CHOICE_ERROR_MESSAGE;
+
         quote! {
-            Err(#crate_root::de::Error::custom("`CHOICE`-style enums cannot be implicitly tagged."))
+            Err(#crate_root::de::Error::custom(#error))
         }
     };
 

diff --git a/macros/src/encode.rs b/macros/src/encode.rs
@@ -92,8 +92,9 @@ pub fn derive_enum_impl(
             encoder.encode_enumerated(tag, *self as isize).map(drop)
         }
     } else {
+        let error = crate::CHOICE_ERROR_MESSAGE;
         quote! {
-            Err::<(), _>(#crate_root::enc::Error::custom("CHOICE-style enums do not allow implicit tagging."))
+            Err::<(), _>(#crate_root::enc::Error::custom(#error))
         }
     };
 

diff --git a/macros/src/lib.rs b/macros/src/lib.rs
@@ -10,6 +10,7 @@ mod tag;
 use config::Config;
 
 const CRATE_NAME: &str = "rasn";
+const CHOICE_ERROR_MESSAGE: &str = "CHOICE-style enums do not allow implicit tagging. If using the derive macro on a sequence with a choice field ensure it is marked with `#[rasn(choice)]`.";
 
 /// Helper function print out the derive.
 fn __print_stream(stream: proc_macro2::TokenStream) -> proc_macro::TokenStream {