Enum Parse

#[non_exhaustive]
pub enum Parse {
    Struct {
        attributes: Vec<Attribute>,
        visibility: Visibility,
        name: Ident,
        generics: Option<Generics>,
        generic_constraints: Option<GenericConstraints>,
        body: StructBody,
    },
    Enum {
        attributes: Vec<Attribute>,
        visibility: Visibility,
        name: Ident,
        generics: Option<Generics>,
        generic_constraints: Option<GenericConstraints>,
        body: EnumBody,
    },
}

Parser for Enum and Struct derives.

You can generate this enum by calling

use virtue::prelude::*;

#[proc_macro_derive(YourDerive)]
pub fn derive_your_derive(input: TokenStream) -> TokenStream {
    let parse = Parse::new(input).unwrap();
    // rest
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Struct

The given input is a struct

Fields

attributes: Vec<Attribute>

The attributes of the struct

visibility: Visibility

The visibility of the struct

name: Ident

The name of the struct

generics: Option<Generics>

The generics of the struct, e.g. struct Foo<F> { ... } will be F

generic_constraints: Option<GenericConstraints>

The generic constraits of the struct, e.g. struct Foo<F> { ... } where F: Display will be F: Display

body: StructBody

The body of the struct

Enum

The given input is an enum

Fields

attributes: Vec<Attribute>

The attributes of the enum

visibility: Visibility

The visibility of the enum

name: Ident

The name of the enum

generics: Option<Generics>

The generics of the enum, e.g. enum Foo<F> { ... } will be F

generic_constraints: Option<GenericConstraints>

The generic constraits of the enum, e.g. enum Foo<F> { ... } where F: Display will be F: Display

body: EnumBody

The body of the enum

Implementations

impl Parse

pub fn new(input: TokenStream) -> Result<Self>

Parse the given TokenStream and return the result.

pub fn into_generator(self) -> (Generator, Vec<Attribute>, Body)

Split this struct or enum into a Generator, list of Attribute and Body.