Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sewer56/derive-enum-all-values
A procedural derive macro which exposes a method named `all_values` that returns all defined values as a compile-time static.
https://github.com/sewer56/derive-enum-all-values
Last synced: 19 days ago
JSON representation
A procedural derive macro which exposes a method named `all_values` that returns all defined values as a compile-time static.
- Host: GitHub
- URL: https://github.com/sewer56/derive-enum-all-values
- Owner: Sewer56
- License: mit
- Created: 2023-09-25T01:33:28.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-23T17:47:41.000Z (5 months ago)
- Last Synced: 2024-09-18T00:10:05.122Z (2 months ago)
- Language: Rust
- Size: 13.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- Contributing: CONTRIBUTING.MD
- License: LICENSE
Awesome Lists containing this project
README
# derive-enum-all-values
[](https://crates.io/crates/derive-enum-all-values)
[](https://docs.rs/derive-enum-all-values)
[](https://github.com/Sewer56/derive-enum-all-values/actions)
## About
A procedural derive macro which exposes a method named `all_values` that returns all defined values as a compile-time static.
## Usage
Add `derive-enum-all-values` to your `Cargo.toml`:
```toml
[dependencies]
derive-enum-all-values = "0.1.0"
```
And then derive `AllValues` for your enum:
```rust
use derive_enum_all_values::AllValues;
#[derive(AllValues)]
enum MyEnum {
Variant1,
Variant2,
// ... other variants ...
}
fn main() {
for variant in MyEnum::all_values() {
println!("{:?}", variant);
}
}
```
This macro generates the following code:
```rust
impl MyEnum {
pub fn all_values() -> &'static [MyEnum] {
&[MyEnum::Variant1, MyEnum::Variant2]
}
}
```
A static, compile time known array containing every enum value.
## Development
How to develop this project.
***Clone this Repository:***
```bash
# When cloning, make sure symlinks are enabled
git clone -c core.symlinks=true https://github.com/Sewer56/derive-enum-all-values.git
```
***Install Rust:***
- Install the [Rust Toolchain.][rust-toolchain]***Setup IDE***
- This repository is fully with VSCode. [Guidance below](#visual-studio-code-integration).
### Visual Studio Code Integration
`Code`/`VSCode` is the de-facto Rust development environment.
The following extensions are required:
- [rust-analyzer][rust-analyzer] for Rust support.
- [coverage-gutters][coverage-gutters] for Coverage support.
- [CodeLLDB][codelldb] for debugging.
- [crates](https://marketplace.visualstudio.com/items?itemName=serayuzgur.crates) easier dependency management.
The VSCode configuration in Reloaded projects (`.vscode`) contain the following:
- Run Rust linter `clippy` on Save.
- Run code format `rustfmt` on Save.
- Tasks for common operations (generate documentation, active CI/CD etc.).
These configurations are in the `.vscode` folder; and the tasks can be ran via `Ctrl+Shift+P -> Run Task`.
## File Layout
The following is the expected file layout for your project:
```
.vscode/
src/
Cargo.toml
```
The `src` folder should contains all source code for your project.
`Cargo.toml` should be in the root of the project.
## Contributing
See [CONTRIBUTING](CONTRIBUTING.MD) for guidance on how to contribute to this project.
## License
Licensed under [MIT](./LICENSE).
[codelldb]: https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb
[coverage-gutters]: https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters
[rust-analyzer]: https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer
[rust-toolchain]: https://www.rust-lang.org/tools/install