Merge #962

962: allow deriving of `FromVariant` for uninhabitable enums r=Bromeon a=Bogay

Fixs #444 
What type of error should be returned might need further discussion.

Co-authored-by: bogay <[email protected]>

Author: bors[bot]

gdnative-derive/src/variant/from.rs

@@ -31,13 +31,6 @@ pub(crate) fn expand_from_variant(derive_data: DeriveData) -> Result<TokenStream
             }
         }
         Repr::Enum(variants) => {
-            if variants.is_empty() {
-                return Err(syn::Error::new(
-                    ident.span(),
-                    "cannot derive FromVariant for an uninhabited enum",
-                ));
-            }
-
             let var_input_ident = Ident::new("__enum_variant", Span::call_site());
 
             let var_ident_strings: Vec<String> = variants
@@ -62,46 +55,55 @@ pub(crate) fn expand_from_variant(derive_data: DeriveData) -> Result<TokenStream
 
             let var_input_ident_iter = std::iter::repeat(&var_input_ident);
 
+            // Return `FromVariantError` if input is an uninhabitable enum
+            let early_return = variants.is_empty().then(|| {
+                quote! {
+                    return Err(FVE::UnknownEnumVariant {
+                        variant: __key,
+                        expected: &[],
+                    });
+                }
+            });
+
             quote! {
-                {
-                    let __dict = ::gdnative::core_types::Dictionary::from_variant(#input_ident)
-                        .map_err(|__err| FVE::InvalidEnumRepr {
-                            expected: VariantEnumRepr::ExternallyTagged,
-                            error: std::boxed::Box::new(__err),
-                        })?;
-
-                    let __keys = __dict.keys();
-                    if __keys.len() != 1 {
-                        Err(FVE::InvalidEnumRepr {
-                            expected: VariantEnumRepr::ExternallyTagged,
-                            error: std::boxed::Box::new(FVE::InvalidLength {
-                                expected: 1,
-                                len: __keys.len() as usize,
-                            }),
-                        })
-                    }
-                    else {
-                        let __key = String::from_variant(&__keys.get(0))
-                            .map_err(|__err| FVE::InvalidEnumRepr {
-                                expected: VariantEnumRepr::ExternallyTagged,
-                                error: std::boxed::Box::new(__err),
-                            })?;
-                        match __key.as_str() {
-                            #(
-                                #ref_var_ident_string_literals => {
-                                    let #var_input_ident_iter = &__dict.get_or_nil(&__keys.get(0));
-                                    (#var_from_variants).map_err(|err| FVE::InvalidEnumVariant {
-                                        variant: #ref_var_ident_string_literals,
-                                        error: std::boxed::Box::new(err),
-                                    })
-                                },
-                            )*
-                            variant => Err(FVE::UnknownEnumVariant {
-                                variant: variant.to_string(),
-                                expected: &[#(#ref_var_ident_string_literals),*],
-                            }),
-                        }
-                    }
+                let __dict = ::gdnative::core_types::Dictionary::from_variant(#input_ident)
+                    .map_err(|__err| FVE::InvalidEnumRepr {
+                        expected: VariantEnumRepr::ExternallyTagged,
+                        error: std::boxed::Box::new(__err),
+                    })?;
+                let __keys = __dict.keys();
+                if __keys.len() != 1 {
+                    return Err(FVE::InvalidEnumRepr {
+                        expected: VariantEnumRepr::ExternallyTagged,
+                        error: std::boxed::Box::new(FVE::InvalidLength {
+                            expected: 1,
+                            len: __keys.len() as usize,
+                        }),
+                    })
+                }
+
+                let __key = String::from_variant(&__keys.get(0))
+                .map_err(|__err| FVE::InvalidEnumRepr {
+                    expected: VariantEnumRepr::ExternallyTagged,
+                    error: std::boxed::Box::new(__err),
+                })?;
+
+                #early_return
+
+                match __key.as_str() {
+                    #(
+                        #ref_var_ident_string_literals => {
+                            let #var_input_ident_iter = &__dict.get_or_nil(&__keys.get(0));
+                            (#var_from_variants).map_err(|err| FVE::InvalidEnumVariant {
+                                variant: #ref_var_ident_string_literals,
+                                error: std::boxed::Box::new(err),
+                            })
+                        },
+                    )*
+                    variant => Err(FVE::UnknownEnumVariant {
+                        variant: variant.to_string(),
+                        expected: &[#(#ref_var_ident_string_literals),*],
+                    }),
                 }
             }
         }

gdnative-derive/src/variant/mod.rs

@@ -107,3 +107,17 @@ pub(crate) fn derive_from_variant(derive_input: DeriveInput) -> Result<TokenStre
     let variant = parse_derive_input(derive_input, &bound, Direction::From);
     from::expand_from_variant(variant?)
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn derive_from_variant_on_uninhabitable_enums() {
+        let input = parse_quote! {
+            enum Test {}
+        };
+
+        derive_from_variant(input).unwrap();
+    }
+}

test/src/test_derive.rs

@@ -1,4 +1,5 @@
 use std::cell::{self, Cell, RefCell};
+use std::collections::HashMap;
 use std::rc::Rc;
 
 use gdnative::export::Property;
@@ -146,6 +147,19 @@ crate::godot_itest! { test_derive_to_variant {
         Ok(ToVarTuple::<f64, i128>(1, 0, false)),
         ToVarTuple::from_variant(&variant)
     );
+
+    // Derive on uninhabitable enum results an error
+    #[derive(Debug, PartialEq, FromVariant)]
+    enum NoVariant {}
+
+    let input = HashMap::from_iter([("foo", "bar")]).to_variant();
+    assert_eq!(
+        NoVariant::from_variant(&input),
+        Err(FromVariantError::UnknownEnumVariant {
+            variant: "foo".into(),
+            expected: &[]
+        })
+    );
 }}
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------