Finite state machines in rust; bendns fork to add types.
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index f55746e..8faaa5b 100644
--- a/README.md
+++ b/README.md
@@ -57,6 +57,7 @@ use rust_fsm::*;
state_machine! {
derive(Debug)
+ repr_c(true)
CircuitBreaker(Closed)
Closed(Unsuccessful) => Open [SetupTimer],
@@ -72,6 +73,8 @@ This code sample:
* Defines a state machine called `CircuitBreaker`;
* Derives the `Debug` trait for it (the `derive` section is optional);
+* Adds repr(C) support to generated code for better FFI compatability
+ (the `repr_c` section is optional and defaults to false);
* Sets the initial state of this state machine to `Closed`;
* Defines state transitions. For example: on receiving the `Successful`
input when in the `HalfOpen` state, the machine must move to the `Closed`