#enum #macros #derive #attribute

macro auto_enums_derive

An internal crate to support auto_enums - do not use directly

37 releases

✓ Uses Rust 2018 edition

0.7.1 Nov 16, 2019
0.6.4 Sep 28, 2019
0.5.9 Jul 7, 2019
0.5.5 Mar 29, 2019
0.3.2 Dec 27, 2018

#19 in #attribute

Download history 654/week @ 2019-10-11 1058/week @ 2019-10-18 909/week @ 2019-10-25 986/week @ 2019-11-01 852/week @ 2019-11-08 1876/week @ 2019-11-15 1639/week @ 2019-11-22 2041/week @ 2019-11-29 2131/week @ 2019-12-06 2326/week @ 2019-12-13 567/week @ 2019-12-20 402/week @ 2019-12-27 775/week @ 2020-01-03 1426/week @ 2020-01-10 1480/week @ 2020-01-17

5,546 downloads per month
Used in 7 crates (via auto_enums)

Apache-2.0 OR MIT

49KB
1.5K SLoC

auto_enums

crates-badge docs-badge license-badge rustc-badge

A library for to allow multiple return types by automatically generated enum.

This crate is a procedural macro implementation of the features discussions in https://github.com/rust-lang/rfcs/issues/2414.

This library provides the following attribute macros:

  • #[auto_enum]

    Parses syntax, creates the enum, inserts variants, and passes specified traits to #[enum_derive].

  • #[enum_derive]

    Implements specified traits to the enum.

Usage

Add this to your Cargo.toml:

[dependencies]
auto_enums = "0.7"

The current auto_enums requires Rust 1.31 or later.

Examples

#[auto_enum]'s basic feature is to wrap the value returned by the obvious branches (match, if, return, etc..) by an enum that implemented the specified traits.

use auto_enums::auto_enum;

#[auto_enum(Iterator)]
fn foo(x: i32) -> impl Iterator<Item = i32> {
    match x {
        0 => 1..10,
        _ => vec![5, 10].into_iter(),
    }
}

#[auto_enum] generates code in two stages.

First, #[auto_enum] will do the following.

  • parses syntax
  • creates the enum
  • inserts variants

Code like this will be generated:

fn foo(x: i32) -> impl Iterator<Item = i32> {
    #[::auto_enums::enum_derive(Iterator)]
    enum __Enum1<__T1, __T2> {
        __T1(__T1),
        __T2(__T2),
    }

    match x {
        0 => __Enum1::__T1(1..10),
        _ => __Enum1::__T2(vec![5, 10].into_iter()),
    }
}

Next, #[enum_derive] implements the specified traits.

Code like this will be generated

#[auto_enum] can also parse nested arms/branches by using the #[nested] attribute.

use auto_enums::auto_enum;
#[auto_enum(Iterator)]
fn foo(x: i32) -> impl Iterator<Item = i32> {
    match x {
        0 => 1..10,
        #[nested]
        _ => match x {
            1 => vec![5, 10].into_iter(),
            _ => 0..=x,
        },
    }
}

See API Documentation for more details.

Supported traits

#[enum_derive] implements the supported traits and passes unsupported traits to #[derive].

If you want to use traits that are not supported by #[enum_derive], you can use another crate that provides proc_macro_derive, or you can define proc_macro_derive yourself (derive_utils probably can help it).

Basic usage of #[enum_derive]

use auto_enums::enum_derive;

// `#[enum_derive]` implements `Iterator`, and `#[derive]` implements `Clone`.
#[enum_derive(Iterator, Clone)]
enum Foo<A, B> {
    A(A),
    B(B),
}

[std|core] libraries

Some traits support is disabled by default. Note that some traits have aliases.

When using features that depend on unstable APIs, the "unstable" feature must be explicitly enabled

[std|core]::iter

See also iter-enum crate.

[std|core]::future

See also futures-enum crate.

std::io

See also io-enum crate.

[std|core]::ops

  • Deref (requires "ops" crate feature)
  • DerefMut (requires "ops" crate feature)
  • Index (requires "ops" crate feature)
  • IndexMut (requires "ops" crate feature)
  • RangeBounds (requires "ops" crate feature)
  • Fn (requires "fn_traits" and "unstable" crate features)
  • FnMut (requires "fn_traits" and "unstable" crate features)
  • FnOnce (requires "fn_traits" and "unstable" crate features)
  • Generator (requires "generator_trait" and "unstable" crate features)

[std|core]::convert

  • AsRef (requires "convert" crate feature)
  • AsMut (requires "convert" crate feature)

[std|core]::fmt

std::error

External libraries

You can add support for external library by activating the each crate feature.

futures(v0.3) (requires "futures" crate feature)

See also futures-enum crate.

futures(v0.1) (requires "futures01" crate feature)

rayon (requires "rayon" crate feature)

serde (requires "serde" crate feature)

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~0.6–0.9MB
~20K SLoC