#dynamic-dispatch #declarative-macro #traits #enums #dynamic #generation #boilerplate

declarative_enum_dispatch

Declarative macro generating boilerplate for enum dispatch

3 releases

0.1.2 Aug 4, 2024
0.1.1 Jun 6, 2024
0.1.0 Apr 15, 2024

#703 in Rust patterns

MIT/Apache

19KB
90 lines

Declarative generation of enum dispatch

Crates.io docs.rs

Generate boilerplate code for dynamic dispatch of a trait using an enum. Also generates From for every enum variant

This is a fully declarative version of enum_dispatch macro

For benchmarks look at enum_dispatch benchmarks crate

use declarative_enum_dispatch::enum_dispatch;

enum_dispatch!(
    /// Supports trait inheritance + lifetime (although single and after traits)
    pub trait ShapeTrait: Clone + std::fmt::Debug + 'static {
        /// No return + default implementation
        fn print_name(&self) {
            println!("name: `{}`", self.name());
        }
        /// Basic call without arguments
        fn name(&self) -> String;
        fn area(&self) -> i32;

        /// Mutable self + arguments
        fn grow(&mut self, numerator: i32, denominator: i32);

        /// Kinda supports generics :) Bot not generic parameters, only `impl Trait`
        fn greater(&self, other: &impl ShapeTrait) -> bool;
        
        /// Supports async methods
        async fn send(&self);

        /// Works with attributes
        #[cfg(feature = "platform_specific")]
        fn platform_specific(self);
    }

    #[derive(Debug, Clone)]
    pub enum Shape {
        Rect(Rect),
        Circle(Circle),
        #[cfg(feature = "platform_specific")]
        Cube(Cube)
    }
);

#[derive(Debug, Clone)]
pub struct Rect{ w: i32, h: i32 }

#[derive(Debug, Clone)]
pub struct Circle { r: i32 }

impl ShapeTrait for Rect {
    fn print_name(&self) {
        println!("rect name: `{}`", self.name());
    }
    fn name(&self) -> String {
        "Rect".to_string()
    }

    fn area(&self) -> i32 {
        self.w * self.h
    }

    fn grow(&mut self, numerator: i32, denominator: i32) {
        self.w = self.w * numerator / denominator;
        self.h = self.h * numerator / denominator;
    }

    fn greater(&self, other: &impl ShapeTrait) -> bool {
        self.area() > other.area()
    }

    async fn send(&self) {}
}

impl ShapeTrait for Circle {
    fn name(&self) -> String {
        "Circle".to_string()
    }

    fn area(&self) -> i32 {
        // close enough PI approximation :)
        3 * self.r * self.r
    }

    fn grow(&mut self, numerator: i32, denominator: i32 ) {
        self.r = self.r * numerator / denominator;
    }

    fn greater(&self, other: &impl ShapeTrait) -> bool {
        self.area() > other.area()
    }

    async fn send(&self) {}
}


assert_eq!(Shape::Rect(Rect { w: 1.0, h: 1.0 }).name(), "Rect".to_string());
assert_eq!(Shape::Circle(Circle { r: 1.0 }).name(), "Circle".to_string());

Roadmap

  • Support generic params
  • Support lifetimes
  • Support trait inheritance
  • Support async functions

Why?

Because I can... Well... RustRover indexing doesn't work with enum dispatch and in one of the threads about this problem I've read

enum_dispatch is a rare example of absolutely IDE-unfriendly macros. It breaks every imaginable rule. With current design, enum_dispatch will never be supported. (source)

So it got me wondering if it can be implemented using declarative macro for "perfect" IDE support, and so... it can)

Yes, I am fixing crate to make it index correctly in my paid IDE.

I WANT MY DAMN AUTOCOMPLETION

No runtime deps