-
Notifications
You must be signed in to change notification settings - Fork 124
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
17 changed files
with
361 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # What `#[derive(TryFrom)]` generates | ||
|
|
||
| This derive allows you to convert enum discriminants into their corresponding variants. | ||
| By default a `TryFrom<isize>` is generated, matching the [type of the discriminant](https://doc.rust-lang.org/reference/items/enumerations.html#discriminants). | ||
| The type can be changed with a `#[repr(u/i*)]` attribute, e.g., `#[repr(u8)]` or `#[repr(i32)]`. | ||
| Only field-less variants can be constructed from their variant, therefor the `TryFrom` implementation will return an error for a discriminant representing a variant with fields. | ||
|
|
||
| ## Example usage | ||
|
|
||
| ```rust | ||
| # #[rustversion::since(1.66)] | ||
| # mod discriminant_on_non_unit_enum { | ||
| # use derive_more::TryFrom; | ||
| #[derive(TryFrom, Debug, PartialEq)] | ||
| #[repr(u32)] | ||
| enum Enum { | ||
| Implicit, | ||
| Explicit = 5, | ||
| Field(usize), | ||
| Empty{}, | ||
| } | ||
|
|
||
| # #[rustversion::since(1.66)] | ||
| # pub fn test(){ | ||
| assert_eq!(Enum::Implicit, Enum::try_from(0).unwrap()); | ||
| assert_eq!(Enum::Explicit, Enum::try_from(5).unwrap()); | ||
| assert_eq!(Enum::Empty{}, Enum::try_from(7).unwrap()); | ||
|
|
||
| // variants with fields are not supported | ||
| assert!(Enum::try_from(6).is_err()); | ||
| # } | ||
| # } | ||
| # // We need to use a `function` declaration, because we cannot put `rustversion` on a statement. | ||
| # #[rustversion::since(1.66)] use discriminant_on_non_unit_enum::test; | ||
| # #[rustversion::before(1.66)] fn test() {} | ||
| # test(); | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| //! Implementation of a [`TryFrom`] derive macro. | ||
|
|
||
| use proc_macro2::{Literal, Span, TokenStream}; | ||
| use quote::{format_ident, quote, ToTokens as _}; | ||
| use syn::{spanned::Spanned as _, Ident, Variant}; | ||
|
|
||
| /// Expands a [`TryFrom`] derive macro. | ||
| pub fn expand(input: &syn::DeriveInput, _: &'static str) -> syn::Result<TokenStream> { | ||
| match &input.data { | ||
| syn::Data::Struct(data) => Err(syn::Error::new( | ||
| data.struct_token.span(), | ||
| "`TryFrom` cannot be derived for structs", | ||
| )), | ||
| syn::Data::Enum(data) => Expansion { | ||
| repr: ReprAttribute::parse_attrs(&input.attrs)?, | ||
| ident: &input.ident, | ||
| variants: data.variants.iter().collect(), | ||
| generics: &input.generics, | ||
| } | ||
| .expand(), | ||
| syn::Data::Union(data) => Err(syn::Error::new( | ||
| data.union_token.span(), | ||
| "`TryFrom` cannot be derived for unions", | ||
| )), | ||
| } | ||
| } | ||
|
|
||
| /// Representation of a [`Repr`] derive macro struct container attribute. | ||
| /// | ||
| /// ```rust,ignore | ||
| /// #[repr(<type>)] | ||
| /// ``` | ||
| struct ReprAttribute(Ident); | ||
|
|
||
| impl ReprAttribute { | ||
| /// Parses a [`StructAttribute`] from the provided [`syn::Attribute`]s. | ||
| fn parse_attrs(attrs: impl AsRef<[syn::Attribute]>) -> syn::Result<Self> { | ||
| attrs | ||
| .as_ref() | ||
| .iter() | ||
| .filter(|attr| attr.path().is_ident("repr")) | ||
| .try_fold(None, |mut repr, attr| { | ||
| attr.parse_nested_meta(|meta| { | ||
| if let Some(ident) = meta.path.get_ident() { | ||
| if let "u8" | "u16" | "u32" | "u64" | "u128" | "usize" | "i8" | ||
| | "i16" | "i32" | "i64" | "i128" | "isize" = | ||
| ident.to_string().as_str() | ||
| { | ||
| repr = Some(ident.clone()); | ||
| return Ok(()); | ||
| } | ||
| } | ||
| // ignore all other attributes that could have a body e.g. `align` | ||
| _ = meta.input.parse::<proc_macro2::Group>(); | ||
| Ok(()) | ||
| }) | ||
| .map(|_| repr) | ||
| }) | ||
| // Default discriminant is interpreted as `isize` (https://doc.rust-lang.org/reference/items/enumerations.html#discriminants) | ||
| .map(|repr| repr.unwrap_or_else(|| Ident::new("isize", Span::call_site()))) | ||
| .map(Self) | ||
| } | ||
| } | ||
|
|
||
| /// Expansion of a macro for generating [`TryFrom`] implementation of an enum | ||
| struct Expansion<'a> { | ||
| /// Enum `#[repr(u/i*)]` | ||
| repr: ReprAttribute, | ||
| /// Enum [`Ident`]. | ||
| ident: &'a Ident, | ||
|
|
||
| /// Variant [`Ident`] in case of enum expansion. | ||
| variants: Vec<&'a syn::Variant>, | ||
|
|
||
| /// Struct or enum [`syn::Generics`]. | ||
| generics: &'a syn::Generics, | ||
| } | ||
|
|
||
| impl<'a> Expansion<'a> { | ||
| /// Expands [`TryFrom`] implementations for a struct. | ||
| fn expand(&self) -> syn::Result<TokenStream> { | ||
| let ident = self.ident; | ||
| let (impl_generics, ty_generics, where_clause) = self.generics.split_for_impl(); | ||
|
|
||
| let repr = &self.repr.0; | ||
|
|
||
| let mut last_discriminant = quote! {0}; | ||
| let mut inc = 0usize; | ||
| let (consts, (discriminants, variants)): ( | ||
| Vec<Ident>, | ||
| (Vec<TokenStream>, Vec<TokenStream>), | ||
| ) = self | ||
| .variants | ||
| .iter() | ||
| .filter_map( | ||
| |Variant { | ||
| ident, | ||
| fields, | ||
| discriminant, | ||
| .. | ||
| }| { | ||
| if let Some(discriminant) = discriminant { | ||
| last_discriminant = discriminant.1.to_token_stream(); | ||
| inc = 0; | ||
| } | ||
| let ret = { | ||
| let inc = Literal::usize_unsuffixed(inc); | ||
| fields.is_empty().then_some(( | ||
| format_ident!("__DISCRIMINANT_{ident}"), | ||
| ( | ||
| quote! {#last_discriminant + #inc}, | ||
| quote! {#ident #fields}, | ||
| ), | ||
| )) | ||
| }; | ||
| inc += 1; | ||
| ret | ||
| }, | ||
| ) | ||
| .unzip(); | ||
|
|
||
| Ok(quote! { | ||
| #[automatically_derived] | ||
| impl #impl_generics | ||
| ::core::convert::TryFrom<#repr #ty_generics> for #ident | ||
| #where_clause | ||
| { | ||
| type Error = ::derive_more::TryFromError<#repr>; | ||
|
|
||
| #[inline] | ||
| fn try_from(value: #repr) -> ::core::result::Result<Self, Self::Error> { | ||
| #(#[allow(non_upper_case_globals)] const #consts: #repr = #discriminants;)* | ||
| match value { | ||
| #(#consts => ::core::result::Result::Ok(#ident::#variants),)* | ||
| _ => ::core::result::Result::Err(::derive_more::TryFromError::new(value)), | ||
| } | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| #[derive(derive_more::TryFrom)] | ||
| #[repr(a + b)] | ||
| enum Enum { | ||
| Variant | ||
| } | ||
|
|
||
| fn main() {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| error: expected `,` | ||
| --> tests/compile_fail/try_from/invalid_repr.rs:2:10 | ||
| | | ||
| 2 | #[repr(a + b)] | ||
| | ^ | ||
|
|
||
| error: expected one of `(`, `,`, `::`, or `=`, found `+` | ||
| --> tests/compile_fail/try_from/invalid_repr.rs:2:10 | ||
| | | ||
| 2 | #[repr(a + b)] | ||
| | ^ expected one of `(`, `,`, `::`, or `=` |
Oops, something went wrong.