Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cocoonspace/fsm
Finite State Machine package in Go
https://github.com/cocoonspace/fsm
Last synced: 13 days ago
JSON representation
Finite State Machine package in Go
- Host: GitHub
- URL: https://github.com/cocoonspace/fsm
- Owner: cocoonspace
- License: mit
- Created: 2021-10-11T10:12:51.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-08T13:23:22.000Z (over 1 year ago)
- Last Synced: 2024-07-31T20:48:00.773Z (3 months ago)
- Language: Go
- Size: 16.6 KB
- Stars: 59
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - fsm - Finite-State Machine package. (Data Structures and Algorithms / Miscellaneous Data Structures and Algorithms)
- awesome-go - fsm - Finite-State Machine package. (Data Structures and Algorithms / Miscellaneous Data Structures and Algorithms)
- awesome-go-extra - fsm - 10-11T10:12:51Z|2021-10-12T20:13:09Z| (Generators / Miscellaneous Data Structures and Algorithms)
README
# fsm [](https://pkg.go.dev/github.com/cocoonspace/fsm) [](https://app.travis-ci.com/cocoonspace/fsm) [](https://coveralls.io/github/cocoonspace/fsm?branch=master) [](https://goreportcard.com/report/github.com/cocoonspace/fsm)
Package fsm allows you to add [finite-state machines](https://en.wikipedia.org/wiki/Finite-state_machine) to your Go code.
States and Events are defined as int consts:
```go
const (
StateFoo fsm.State = iota
StateBar
)
const (
EventFoo fsm.Event = iota
EventBar
)
f := fsm.New(StateFoo)
f.Transition(
fsm.On(EventFoo), fsm.Src(StateFoo),
fsm.Dst(StateBar),
)
```
You can have custom checks or actions:
```go
f.Transition(
fsm.Src(StateFoo), fsm.Check(func () bool {
// check something
}),
fsm.Call(func () {
// do something
}),
)
```
Transitions can be triggered the second time an event occurs:
```go
f.Transition(
fsm.On(EventFoo), fsm.Src(StateFoo), fsm.Times(2),
fsm.Dst(StateBar),
)
```
Functions can be called when entering or leaving a state:
```go
f.EnterState(StateFoo, func() {
// do something
})
f.Enter(func(state fsm.State) {
// do something
})
f.ExitState(StateFoo, func() {
// do something
})
f.Exit(func(state fsm.State) {
// do something
})
```
## Performance
This package is much faster and does a lot less allocations than github.com/looplab/fsm:
```
BenchmarkCocoonSpaceFSM-12 29371851 40.32 ns/op 0 B/op 0 allocs/op
BenchmarkLooplabFSM-12 2438946 487.8 ns/op 320 B/op 4 allocs/op
```
(benchmark data is for two executed transitions)
Benchmark information on https://github.com/cocoonspace/fsm-bench
## Installation
go get github.com/cocoonspace/fsm
## Contribution guidelines
Contributions are welcome, as long as:
* unit tests & comments are included,
* no external package is used.
## License
MIT - See LICENSE