rev: 08a0786d94a50b3b229836c53a03976f10ab6bd7 scopes/doc/docs/module-enum.md -rw-r--r-- 1.4 KiB View raw Log this file
08a0786d94a5Shawn Walker-Salas * drop number sections in menu due to readthedocs theme incompatibility 19 days ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
<style type="text/css" rel="stylesheet">body { counter-reset: chapter 12; }</style>

enum
====

Support for defining tagged unions and classical enums through the `enum`
sugar.

*type*{.property} `Enum`{.descname} [](#scopes.type.Enum "Permalink to this definition"){.headerlink} {#scopes.type.Enum}

:   An opaque type.

    *spice*{.property} `__dispatch`{.descname} (*&ensp;...&ensp;*)[](#scopes.Enum.spice.__dispatch "Permalink to this definition"){.headerlink} {#scopes.Enum.spice.__dispatch}

    :   

    *spice*{.property} `__unsafe-dispatch2`{.descname} (*&ensp;...&ensp;*)[](#scopes.Enum.spice.__unsafe-dispatch2 "Permalink to this definition"){.headerlink} {#scopes.Enum.spice.__unsafe-dispatch2}

    :   

    *spice*{.property} `apply`{.descname} (*&ensp;...&ensp;*)[](#scopes.Enum.spice.apply "Permalink to this definition"){.headerlink} {#scopes.Enum.spice.apply}

    :   

    *inline*{.property} `literal`{.descname} (*&ensp;self&ensp;*)[](#scopes.Enum.inline.literal "Permalink to this definition"){.headerlink} {#scopes.Enum.inline.literal}

    :   

    *spice*{.property} `unsafe-extract-payload`{.descname} (*&ensp;...&ensp;*)[](#scopes.Enum.spice.unsafe-extract-payload "Permalink to this definition"){.headerlink} {#scopes.Enum.spice.unsafe-extract-payload}

    :   

*sugar*{.property} (`enum`{.descname} *&ensp;...&ensp;*) [](#scopes.sugar.enum "Permalink to this definition"){.headerlink} {#scopes.sugar.enum}

: