aboutsummaryrefslogtreecommitdiff
path: root/hsm-core/Hsm/Core/Fsm.hs
diff options
context:
space:
mode:
authorPaul Oliver <contact@pauloliver.dev>2025-01-14 15:58:56 -0800
committerPaul Oliver <contact@pauloliver.dev>2025-01-16 18:30:09 -0800
commit00ad7b9a1c798e611a0c0b7fcbfa5ee76c2f39c4 (patch)
treef2bcbcd0a8b2a3425b8baec668fccc62a4037ac1 /hsm-core/Hsm/Core/Fsm.hs
parentcc639b06c7126fac7b445d8f778455620d7f8f50 (diff)
Adds minimal documentation
Diffstat (limited to 'hsm-core/Hsm/Core/Fsm.hs')
-rw-r--r--hsm-core/Hsm/Core/Fsm.hs2
1 files changed, 2 insertions, 0 deletions
diff --git a/hsm-core/Hsm/Core/Fsm.hs b/hsm-core/Hsm/Core/Fsm.hs
index 43fa497..6f9910e 100644
--- a/hsm-core/Hsm/Core/Fsm.hs
+++ b/hsm-core/Hsm/Core/Fsm.hs
@@ -26,6 +26,8 @@ data FsmOutput i o env sta =
data FsmResult i o env sta =
FsmResult o sta (FsmState i o env sta)
+-- Finite state machines allow processing of stream elements using pure
+-- functions. One or more FSMs can be included within a `Streamly` pipeline.
fsm ::
forall i o env sta es.
( Log :> es