#enums #helper #compose #variant #macro #type #three

macro unite

A helper macro to compose existing types into an enum

1 unstable release

0.1.2 Aug 11, 2021

#16 in #three

MIT license

10KB
150 lines

Unite

A small helper macro allowing you to compose existing types into an enum.

[dependencies]
unite = "0.1"

Usage

use unite::unite;

pub struct One(bool);
pub struct Two(i32);
pub struct Three(f64);

unite! {
    // defines a new enum with a variant for each struct
    pub enum Any { One, Two, Three }
}

This expands to:

pub enum Any {
    One(One),
    Two(Two),
    Three(Three),
}

Renaming

By default the enum variants use the same name as the type, but renaming is possible.

unite! {
    enum Foo {
        SameName,
        Renamed = i32,
    }
}

Helpers

The generated enums come with helper functions to access their variants with ease. Variant names are automatically converted into snake_case for the function names.

fn foo(any: Any) {
    // checks whether the enum is a specific variant
    let is_one: bool = any.is_one();

    // attempts to cast the enum to a specific variant
    let as_two: Option<&Two> = any.as_two();
    let as_three_mut: Option<&mut Three> = any.as_three_mut();
}

The generated enums also inherently implement From<Variant>.

let any: Any = One(true).into();

Dependencies

~2MB
~42K SLoC