[move][docs] Add section on pattern matching to Move book #17776

tzakian · 2024-05-16T18:34:04Z

Description

Still a bit of a work in progress, but want to put this up for early eyes/feedback anyone might have.

Test plan

👀

vercel · 2024-05-16T18:34:07Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
sui-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 28, 2024 4:22pm

3 Ignored Deployments

Name	Status	Preview	Updated (UTC)
multisig-toolkit	⬜️ Ignored (Inspect)	Visit Preview	May 28, 2024 4:22pm
sui-kiosk	⬜️ Ignored (Inspect)	Visit Preview	May 28, 2024 4:22pm
sui-typescript-docs	⬜️ Ignored (Inspect)	Visit Preview	May 28, 2024 4:22pm

cgswords · 2024-05-16T20:21:17Z

external-crates/move/documentation/book/src/control-flow/pattern-matching.md

@@ -0,0 +1,567 @@
+# Pattern Matching
+
+A `match` expression is a powerful control structure that allows you to compare a value against a


external-crates/move/documentation/book/src/control-flow/pattern-matching.md

cgswords · 2024-05-16T20:31:02Z

external-crates/move/documentation/book/src/control-flow/pattern-matching.md

+OtherEnum::V(MyEnum::Variant(..))
+```
+
+More concisely we have the following grammar for patterns in Move:


We should really collect all the grammar somewhere one day

external-crates/move/documentation/book/src/control-flow/pattern-matching.md

cgswords · 2024-05-16T20:35:16Z

external-crates/move/documentation/book/src/control-flow/pattern-matching.md

+```move
+fun run(x: u64): u64 {
+    match (x) {
+        1 => 2,
+        2 => 3,
+        x => x,
+    }
+}
+
+run(1); // returns 2
+run(2); // returns 3
+run(3); // returns 3
+run(0); // returns 0
+```


I'm in favor of a "flashy" first example. If I end up here, I want the csug description: show me all the usage in 1-2 code examples with all the behavior, then take the time to explain. That way if I'm looking for something quick, it's right here at the top of the file.

I like it, let me think about what a good example like that might be up here :)

external-crates/move/documentation/book/src/control-flow/pattern-matching.md

external-crates/move/documentation/book/src/control-flow.md

Co-authored-by: Cam Swords <cameronswords@gmail.com>

ronny-mysten

Thanks, Tim! Approving to carry forward.

external-crates/move/documentation/book/src/control-flow/pattern-matching.md

Co-authored-by: ronny-mysten <118224482+ronny-mysten@users.noreply.github.com>

tzakian · 2024-05-31T19:48:00Z

Closing in favor of this PR that adds it to the move-book repo: MystenLabs/move-book#69

vercel bot deployed to Preview – sui-docs May 16, 2024 18:35 View deployment

tzakian force-pushed the tzakian/move-docs-enums1 branch from acd3e54 to 034247d Compare May 16, 2024 18:42

tzakian force-pushed the tzakian/move-docs-enums2 branch from c732ebf to bcf0213 Compare May 16, 2024 18:42

vercel bot deployed to Preview – sui-docs May 16, 2024 18:45 View deployment

tzakian force-pushed the tzakian/move-docs-enums2 branch from bcf0213 to a71fa02 Compare May 16, 2024 19:54

vercel bot deployed to Preview – sui-docs May 16, 2024 19:56 View deployment

tzakian force-pushed the tzakian/move-docs-enums2 branch from a71fa02 to 9a6705c Compare May 16, 2024 19:57

tzakian requested a review from a team May 16, 2024 19:58

tzakian marked this pull request as ready for review May 16, 2024 19:58

tzakian requested a review from ronny-mysten as a code owner May 16, 2024 19:58

vercel bot deployed to Preview – sui-docs May 16, 2024 19:59 View deployment