5 ms·
Pretty State Machine Patterns in Rust (2016)
- gnabgib 2y ago(2016) Popular, but barely discussed at the time (62 points, 3 comments) https://news.ycombinator.com/item?id=12703623 https://news.ycombinator.com/item?id=12703623
- locusofself 2y agoIs the title a nod to the Nine Inch Nails album "Pretty Hate Machine" ?
- gnabgib 2y agoPartially, according to op: https://news.ycombinator.com/item?id=12708060 https://news.ycombinator.com/item?id=12708060
- jesse__ 2y agoHonestly, I prefer the long-form first-cut that he dismisses to save 10 lines of code at the cost of using generics.
- jesse__ 2y agoOn a second skim it is nice that errors are surfaced at compile time, but honestly I'm not sure that's worth the complexity.
- kadoban 2y agoI feel like either one could be a reasonable choice, mostly depending on how complex the state machine is and how bad it is if it errors at runtime.
- joshka 2y agoShe, not he. https://www.linkedin.com/in/hoverbear/ https://www.linkedin.com/in/hoverbear/
- gsliepen 2y agoI don't understand why you would code these explicit state machines when you can just write normal code that is much more readable. The state machine example they start with could be written as: while (true) { wait(); fill(); finish(); } I don't think the approach from the article would have any benefits like less bugs or higher performance.
- skavi 2y agoallows trivially mocking effects for testing
- sdenton4 2y agoI tend to think of state machines as becoming important when you're forced to deal with the unpredictably of the real world, rather than just pummeling bits until they repent. You've got some complicated Thing to control which you don't have full visibility into... Like, say, a Bluetooth implementation, or a robot. You have a task to complete, which goes through many steps, and requires some careful reset operations before you can try again when things inevitably don't go according to plan. What steps are needed for the reset depends on where you're at in the process. Maybe you only need to retry from there steps ago instead of going all the way back to the beginning... The states help you keep track of where things are at, and more rigorously define the paths available.
- MrJohz 2y agoFor a very simple example like this, your version will probably be okay, but it has its own set of problems: * It's difficult to introspect the current state of the system. If I were to build an API that fetches the current state, I'd need to do something like add an extra state that the different functions could then update, which makes all the code more messy. By turning this into an explicit state machine, I can encode the states directly in the system and introspect them. * Similarly it's often useful to be able to listen to state transitions in order to update other systems. I could include that as part of the functions themselves, but again, if I just encode this operation as an explicit state machine, the transition points fall out very nicely from that. * Here there is no branching, but state machines can often have complicated branching logic as to which state should be called next. It's possible to write this directly as code, but in my experience, it often gets complicated more quickly than you'd think. This is just a simple example, but in practice a bottle filler probably has extra states to track whether the machine has been turned off, in which case if it's in the `fill` state it will switch to the `finish` or `wait` state to ensure the internal machinery gets reset before losing power. Adding this extra logic to a state machine is usually easier than adding it to imperative code. * In your version, the different functions need to set up the state ready to be used by the next function (or need to rely on the expected internal state at the end of the previous function). This gives the functions an implicit order that is not really enforced anywhere. You can imagine in a more complicated state machine, easily switching up two functions and calling them in the wrong order. In OP's version, because the state is encoded in such a type-safe way, any state transitions must handle the data from the previous state(s) directly, and provide all the correct data for the next state. Even if you were to get some of the states the wrong way round, you'd still need to correctly handle that transition, which prevents anything from breaking even if the behaviour is incorrect.
- skavi 2y agoi think stable coroutines [0] would be huge for rust. they would enable writing pure state machines in the form of straight line imperative code. currently they’re used in the implementation of async/await, but aren’t themselves exposed. [0]: https://doc.rust-lang.org/beta/unstable-book/language-features/coroutines.html https://doc.rust-lang.org/beta/unstable-book/language-featur...
- phibz 2y agoI'm a bit surprised that they don't use the name "type state". Perhaps it wasn't in wide use when this post was originally written? The important ideas here are that each state is moved in to the method that transitions to the next state. This way you're "giving away" your ownership of the data. This is great for preventing errors. You cannot retain access to stale state. And by using the From trait to implement transitions, you ensure that improper transitions are impossible to represent. It's a great pattern and has only grown in use since this was written.
- wging 2y agoI think I first learned of that term from this 2019 article: https://cliffle.com/blog/rust-typestate/ https://cliffle.com/blog/rust-typestate/ I can't be the only one...
- zokier 2y agoTypestates were also notable feature in early Rust, albeit in a very different form. I do recall them mentioned often in presentations/talks/etc at the time. Tbh it would make interesting blog post to compare modern typestate patterns to the historical built-in typestate mechanism. https://github.com/rust-lang/rust/issues/2178 https://github.com/rust-lang/rust/issues/2178
- jelder 2y agoJust a Nine Inch Nails fan who really wanted the title to be a pun on “Pretty Hate Machine.”
- theOGognf 2y agoIt’s funny seeing this blog post again. This is actually a reference I used to make a poker game as a state machine last year: https://github.com/theOGognf/private_poker https://github.com/theOGognf/private_poker It made the development feel a lot safer and it’s nice knowing the poker game state cannot be illegally transitioned with the help of the type system
- joshka 2y agoI prefer giving the transitions explicit names over relying on the From implemenations defined on the machine (defining them on the states still prevents bad transitions). The raft example drops a bunch of syntactic noise and repetition this way: https://play.rust-lang.org/?version=stable&mode=debug&edition=2015&gist=69f5db2ae38230123a96253e95de5cbd https://play.rust-lang.org/?version=stable&mode=debug&editio... fn main() { let is_follower = Raft::new(/* ... */); // Raft typically comes in groups of 3, 5, or 7. Just 1 for us. :) // Simulate this node timing out first. let is_candidate = is_follower.on_timeout(); // It wins! How unexpected. let is_leader = is_candidate.on_wins_vote(); // Then it fails and rejoins later, becoming a Follower again. let is_follower_again = is_leader.on_disconnected(); // And goes up for election... let is_candidate_again = is_follower_again.on_timeout(); // But this time it fails! let is_follower_another_time = is_candidate_again.on_lose_vote(); } // This is our state machine. struct Raft<S> { // ... Shared Values state: S } // The three cluster states a Raft node can be in // If the node is the Leader of the cluster services requests and replicates its state. struct Leader { // ... Specific State Values } // If it is a Candidate it is attempting to become a leader due to timeout or initialization. struct Candidate { // ... Specific State Values } // Otherwise the node is a follower and is replicating state it receives. struct Follower { // ... Specific State Values } impl<S> Raft<S> { fn transition<T: From<S>>(self) -> Raft<T> { let state = self.state.into(); // ... Logic prior to transition Raft { // ... attr: val.attr state, } } } // Raft starts in the Follower state impl Raft<Follower> { fn new(/* ... */) -> Self { // ... Raft { // ... state: Follower { /* ... */ } } } // When a follower timeout triggers it begins to campaign fn on_timeout(self) -> Raft<Candidate> { self.transition() } } impl Raft<Candidate> { // If it doesn't receive a majority of votes it loses and becomes a follower again. fn on_lose_vote(self) -> Raft<Follower> { self.transition() } // If it wins it becomes the leader. fn on_wins_vote(self) -> Raft<Leader> { self.transition() } } impl Raft<Leader> { // If the leader becomes disconnected it may rejoin to discover it is no longer leader fn on_disconnected(self) -> Raft<Follower> { self.transition() } } // The following are the defined transitions between states. // When a follower timeout triggers it begins to campaign impl From<Follower> for Candidate { fn from(state: Follower) -> Self { Candidate { /* ... */ } } } // If it doesn't receive a majority of votes it loses and becomes a follower again. impl From<Candidate> for Follower { fn from(state: Candidate) -> Self { Follower { /* ... */ } } } // If it wins it becomes the leader. impl From<Candidate> for Leader { fn from(val: Candidate) -> Self { Leader { /* ... */ } } } // If the leader becomes disconnected it may rejoin to discover it is no longer leader impl From<Leader> for Follower { fn from(val: Leader) -> Self { Follower { /* ... */ } } }
- michalsustr 2y agoWell this is timely :) I’m in the middle of writing a library, based on rust-fsm crate, that adds nice support for Mealy automata, with extensions like - transition handlers - guards - clocks - composition of automata into a system. The idea is to allow write tooling that will export the automata into UPPAAL and allow for model checking. This way you don’t need to make too much additional effort to ensure your model and implementation match/are up to date, you can run the checker during CI tests to ensure you don’t have code that deadlocks/ some states are always reachable etc. I plan to post a link here to HN once finished.
- dafelst 2y agoPlease do!
- michalsustr 2y agoI published first version: https://github.com/michalsustr/rust-automata https://github.com/michalsustr/rust-automata Happy to get feedback.
- mijoharas 2y agoMaybe I'm missing something, but it seems that this approach doesn't allow you to store external input that's provided when you transition states. Say stateB is transitioned to from stateA and needs to store a value that is _not_ directly computed from stateA but is externally supplied at the point of transition. As far as I understand this isn't possible with the proposed solution? Am I missing something? This seems like a pretty common use case to me.
- vlovich123 2y agoimpl From<(OldState, Input)> for NewState would be one way.
- michalsustr 2y agoHi, I just made a library which does that! I published first version: https://github.com/michalsustr/rust-automata https://github.com/michalsustr/rust-automata Happy to get feedback.
- raphinou 2y agoIs there any crate advised to be used when developing state machines? Any experience to share?
- acid_burn 2y agoI have a particular interest in hierarchical state machines, so I made moku [1] to take care of all the boilerplate associated with them. Its ergonomics are definitely tailored for nested states, but it can generate flat machines perfectly fine. [1] https://docs.rs/moku/latest/moku/ https://docs.rs/moku/latest/moku/
- michalsustr 2y agoHi, I made a new crate since I wasnt happy with the existing ones. I published first version: https://github.com/michalsustr/rust-automata https://github.com/michalsustr/rust-automata Happy to get feedback.
- jll29 2y agoHow about state machines with millions of transitions such as letter transducers?
- pjmlp 2y agoKind of interesting seeing folks rediscovering ideas from Standard ML.
- jfauwasdf 2y agoAre you sure you aren't thinking of Idris or LinearML? Standard ML does not have linear or affine logic AFAIK.
- pjmlp 2y agoThe state machine approach described in the article has nothing to do with linear or affine types.
- jfauwasdf 2y agoWith respect to state machine transitions FTA: "Changing from one state to another should consume the state so it can no longer be used." consume is a dog whistle for affine logic, is it not? also you are right in that state machines themselves don't have anything to do with linear or affine types but this article is about implementing one in rust which has affine logic.
- pjmlp 2y agoIt can be modeled as part of transition states on the type system, doesn't necessarily need affine logic.
- jfauwasdf 2y agoAgreed but I never made the claim they couldn't be. Can you expand on the ideas from Standard ML that are referenced in the article? That's what I'm interested in and didn't intend to go on a tangent here. Apologies for that.
- deleted 2y ago[deleted]
- nativeit 2y agoThis isn't really relevant to the article's topic, but I noticed something in their stylesheet that has me intensely curious--can anyone explain to me what's happening with this CSS rule? * { --index: calc(1 * var(--prime2) * var(--prime3) * var(--prime5) * var(--prime7) * var(--prime11) * var(--prime13) * var(--prime17) * var(--prime19) * var(--prime23) * var(--prime29) * var(--prime31) * var(--prime37) * var(--prime41) * var(--prime43) * var(--prime47) * var(--prime53) * var(--prime59) * var(--prime61) * var(--prime67) * var(--prime71) * var(--prime73) * var(--prime79) * var(--prime83) * var(--prime89) * var(--prime97) * var(--prime101) * var(--prime103) * var(--prime107) * var(--prime109) * var(--prime113) * var(--prime127) * var(--prime131) * var(--prime137) * var(--prime139) * var(--prime149) * var(--prime151) * var(--prime157) * var(--prime163) * var(--prime167) * var(--prime173) * var(--prime179) * var(--prime181) * var(--prime191) * var(--prime193) * var(--prime197) * var(--prime199) * var(--prime211) * var(--prime223) * var(--prime227) * var(--prime229) * var(--prime233) * var(--prime239) * var(--prime241) * var(--prime251) * var(--prime257) * var(--prime263) * var(--prime269) * var(--prime271) * var(--prime277) * var(--prime281) * var(--prime283) * var(--prime293) * var(--prime307) * var(--prime311) * var(--prime313) * var(--prime317) * var(--prime331) * var(--prime337) * var(--prime347) * var(--prime349) * var(--prime353) * var(--prime359) * var(--prime367) * var(--prime373) * var(--prime379) * var(--prime383) * var(--prime389) * var(--prime397) * var(--prime401) * var(--prime409) * var(--prime419) * var(--prime421) * var(--prime431) * var(--prime433) * var(--prime439) * var(--prime443) * var(--prime449) * var(--prime457) * var(--prime461) * var(--prime463) * var(--prime467) * var(--prime479) * var(--prime487) * var(--prime491) * var(--prime499) * var(--prime503) * var(--prime509) * var(--prime521) * var(--prime523) * var(--prime541) * var(--prime547) * var(--prime557) * var(--prime563) * var(--prime569) * var(--prime571) * var(--prime577) * var(--prime587) * var(--prime593) * var(--prime599)); }
- nativeit 2y agoIt appears to be related to how they draw a fancy SVG logo with a starfield and constellation. These variables relate to the positions of the stars in the starfield (or something similar). Clever.
- MarkSweep 2y agoIt's to create random numbers to make the star field on the home page: https://hoverbear.org/ https://hoverbear.org/ It's defined in this file: https://github.com/Hoverbear/hoverbear.org/blob/root/sass/_magic.scss https://github.com/Hoverbear/hoverbear.org/blob/root/sass/_m... Which links to an explanation here: https://medium.com/hypersphere-codes/counting-in-css-unlock-magic-of-css-variables-8e610881097a https://medium.com/hypersphere-codes/counting-in-css-unlock-...