#finite-state-machine #state-machine #state #fsm

no-std finny

使用过程式构建器风格的API和编译时转换检查的有限状态机

3个不稳定版本

0.2.0 2022年1月24日
0.1.1 2021年1月5日
0.1.0 2021年1月5日

#1177 in 算法

Download history 29/week @ 2024-03-10 21/week @ 2024-03-17 5/week @ 2024-03-24 67/week @ 2024-03-31 17/week @ 2024-04-07 3/week @ 2024-04-14

139 每月下载次数

MIT/Apache

93KB
2K SLoC

Finny - Rust的分层有限状态机

Crates.io Documentation Build

特性

  • 声明式、构建器API,带有生成调度器的过程函数宏
  • 编译时转换图验证
  • 无需运行时分配,支持no_std
  • 在共享上下文中支持泛型
  • 转换守卫和动作
  • 状态区域,也称为正交状态
  • 事件队列和运行至完成执行
  • 子机,也称为分层状态机
  • 状态上的计时器

示例

Cargo.toml

[dependencies]
finny = "0.2"

代码

use finny::{finny_fsm, FsmFactory, FsmResult, decl::{BuiltFsm, FsmBuilder}};

// The context is shared between all guards, actions and transitions. Generics are supported here!
#[derive(Default)]
pub struct MyContext { val: u32 }
// The states are plain structs.
#[derive(Default)]
pub struct MyStateA { n: usize }
#[derive(Default)]
pub struct MyStateB;
// The events are also plain structs. They can have fields.
#[derive(Clone)]
pub struct MyEvent;

// The FSM is generated by a procedural macro
#[finny_fsm]
fn my_fsm(mut fsm: FsmBuilder<MyFsm, MyContext>) -> BuiltFsm {
    // The FSM is described using a builder-style API
    fsm.state::<MyStateA>()
       .on_entry(|state, ctx| {
           state.n += 1;
           ctx.context.val += 1;
        })
       .on_event::<MyEvent>()
       .transition_to::<MyStateB>()
       .guard(|_ev, ctx, _states| { ctx.context.val > 0 })
       .action(|_ev, ctx, state_a, state_b| { ctx.context.val += 1; });
    fsm.state::<MyStateB>();
    fsm.initial_state::<MyStateA>();
    fsm.build()
}

// The FSM is built and tested.
fn main() -> FsmResult<()> {
    let mut fsm = MyFsm::new(MyContext::default())?;
    assert_eq!(0, fsm.val);
    fsm.start()?;
    let state_a: &MyStateA = fsm.get_state();
    assert_eq!(1, state_a.n);
    assert_eq!(1, fsm.val);
    fsm.dispatch(MyEvent)?;
    assert_eq!(2, fsm.val);
    Ok(())
}

许可证:MIT OR Apache-2.0

依赖项

~4.5MB
~79K SLoC