Skip to content

Add section about extensible variant types. #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Sep 8, 2021
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions data/sidebar_manual_latest.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@
"unboxed",
"reserved-keywords"
],
"Advanced Features": [
"extensible-variant"
],
"JavaScript Interop": [
"embed-raw-javascript",
"shared-data-types",
Expand Down
73 changes: 73 additions & 0 deletions pages/docs/manual/latest/extensible-variant.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
title: "Extensible Variant"
description: "Extensible Variants in ReScript"
canonical: "/docs/manual/latest/extensible-variant"
---

# Extensible Variant

Variant types are usually constrained to a fixed set of constructors. There may be very rare cases where you still want to be able to add constructors to a variant type even after its initial type declaration. For this, we offer extensible variant types.

## Definition and Usage

<CodeTab labels={["ReScript", "JS Output"]}>

```res example
type t = ..

type t += Other

type t +=
| Point(float, float)
| Line(float, float, float, float)
```
```js
var Caml_exceptions = require("./stdlib/caml_exceptions.js");

var Other = Caml_exceptions.create("Playground.Other");

var Point = Caml_exceptions.create("Playground.Point");

var Line = Caml_exceptions.create("Playground.Line");
```

</CodeTab>

The `..` in the type declaration above defines an extensible variant `type t`. The `+=` operator is then used to add constructors to the given type.

## Pattern Matching Caveats

Extensible variants are open-ended, so the compiler will not be able to exhaustively pattern match all available cases. You will always need to provide a default `_` case for every `switch` expression.


<CodeTab labels={["ReScript", "JS Output"]}>


```res
let print = v =>
switch v {
| Point(x, y) => Js.log2("Point", (x, y))
| Line(ax, ay, bx, by) => Js.log2("Line", (ax, ay, bx, by))
| Other
| _ => Js.log("Other")
}
```
```js
function print(v) {
if (v.RE_EXN_ID === Point) {
console.log("Point", [v._1, v._2]);
} else if (v.RE_EXN_ID === Line) {
console.log("Line", [v._1, v._2, v._3, v._4]);
} else {
console.log("Other");
}
}
```

</CodeTab>

## Tips & Tricks

**Fun fact:** In ReScript, [exceptions](./exception) are actually extensible variants under the hood, so `exception UserError(string)` is equivalent to `type exn += UserError(string)`. It's one of the very few use-case where extensible variants make sense.

We usually recommend sticking with common [variants](./variant) as much as possible to reap the benefits of exhaustive pattern matching.