18 releases

0.0.18 Nov 8, 2024
0.0.17 Jun 14, 2024
0.0.16 Jan 16, 2024
0.0.15 Oct 17, 2023
0.0.3 Dec 14, 2021

#114 in Rust patterns

Download history 44342/week @ 2024-08-23 47161/week @ 2024-08-30 43208/week @ 2024-09-06 42310/week @ 2024-09-13 49882/week @ 2024-09-20 42286/week @ 2024-09-27 45143/week @ 2024-10-04 48742/week @ 2024-10-11 53421/week @ 2024-10-18 50273/week @ 2024-10-25 46779/week @ 2024-11-01 53293/week @ 2024-11-08 54396/week @ 2024-11-15 40290/week @ 2024-11-22 43349/week @ 2024-11-29 122772/week @ 2024-12-06

274,347 downloads per month
Used in 47 crates (9 directly)

MIT license

190KB
3.5K SLoC

Virtue, a sinless derive macro helper

Goals

  • Zero dependencies, so fast compile times
  • No other dependencies needed
  • Declarative code generation
  • As much typesystem checking as possible
  • Build for modern rust: 1.57 and up
  • Build with popular crates in mind:
  • Will always respect semver. Minor releases will never have:
    • Breaking API changes
    • MSRV changes

Example

use virtue::prelude::*;

#[proc_macro_derive(YourDerive, attributes(some, attributes, go, here))]
pub fn derive_your_derive(input: TokenStream) -> TokenStream {
    derive_your_derive_inner(input)
        .unwrap_or_else(|error| error.into_token_stream())
}

fn derive_your_derive_inner(input: TokenStream) -> Result<TokenStream> {
    // Parse the struct or enum you want to implement a derive for
    let parse = Parse::new(input)?;
    // Get a reference to the generator
    let (mut generator, body) = parse.into_generator();
    match body {
        Body::Struct(body) => {
            // Implement your struct body here
            // See `Generator` for more information
            generator.impl_for("YourTrait")?
                    .generate_fn("your_fn")
                    .with_self_arg(FnSelfArg::RefSelf)
                    .body(|fn_body| {
                        fn_body.push_parsed("println!(\"Hello world\");");
                    })?;
        },
        Body::Enum(body) => {
            // Implement your enum body here
            // See `Generator` for more information
            generator.impl_for("YourTrait")?
                    .generate_fn("your_fn")
                    .with_self_arg(FnSelfArg::RefSelf)
                    .body(|fn_body| {
                        fn_body.push_parsed("println!(\"Hello world\");");
                    })?;
        },
    }
    generator.finish()
}

Will generate

impl YourTrait for <Struct or Enum> {
    fn your_fn(&self) { // .generate_fn("your_fn").with_self_arg(FnSelfArg::RefSelf)
        println!("Hello world"); // fn_body.push_parsed(...)
    }
}

Dependencies