filterable-enum

Crates.iofilterable-enum
lib.rsfilterable-enum
version0.1.2
sourcesrc
created_at2024-04-26 08:30:23.838159
updated_at2024-10-10 14:43:41.95315
descriptionA library for generating filterable enums (Combining bitflags and discriminated unions)
homepagehttps://github.com/kxxt/filterable-enum
repositoryhttps://github.com/kxxt/filterable-enum
max_upload_size
id1221210
size7,667
Levi Zim (kxxt)

documentation

README

filterable-enum

Filterable wrapper for discriminated unions(DU) in rust.

What is this?

In some cases, you may want to filter a DU by a bitmask to check if it matches a subset of all variants. This crate provides a derive macro to generate a filterable wrapper for a DU.

Ideally, I think this whole crate should be unnecessary. Rust already stores a tag for representing the variant of a DU. However, Rust does not expose this tag to the user, so I cannot really use that tag as a bitflag.

How to use

See the tests for examples.

To add more derives to the Kind enum, use #[filterable_enum(kind_extra_derive=DeriveMacroYouWant)].

To add more attrs to the Kind enum, use #[filterable_enum(kind_extra_attrs="ATTR")] like #[filterable_enum(kind_extra_attrs="strum(serialize_all = \"kebab-case\")")].

Note

This is the first procedural macro I've ever written, so I'm not sure if I'm doing it idiomatic or right. Feel free to open an issue or PR if you have any suggestions or improvements.

Commit count: 18

cargo fmt