https://github.com/gwllx/typestate-enum
A Rust macro to help build simple Typestate APIs.
https://github.com/gwllx/typestate-enum
rust rust-macros typestate
Last synced: about 2 months ago
JSON representation
A Rust macro to help build simple Typestate APIs.
- Host: GitHub
- URL: https://github.com/gwllx/typestate-enum
- Owner: gwllx
- License: mit
- Created: 2023-11-05T07:05:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-05T10:49:26.000Z (over 2 years ago)
- Last Synced: 2025-12-27T19:49:24.742Z (7 months ago)
- Topics: rust, rust-macros, typestate
- Language: Rust
- Homepage: https://crates.io/crates/typestate-enum
- Size: 1.03 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typestate-enum
A Rust macro to help build simple Typestate APIs.
## Example
The following example defines a trait ``State`` and 3 zero-sized types which
implement it: ``Ready``, ``Working``, and ``Complete``. The types can then be
used to build simple Typestate APIs.
```rust
use typestate_enum::typestate_enum;
use std::marker::PhantomData;
typestate_enum! {
pub State {
Ready,
Working,
Complete
}
}
struct Action(PhantomData);
impl Action {
fn new() -> Self {
Action::(PhantomData)
}
}
impl Action {
fn start_work(self) -> Action {
Action::new()
}
}
impl Action {
fn complete_work(self) -> Action {
Action::new()
}
}
```