diff options
author | Louis Pilfold <louis@lpil.uk> | 2024-03-26 13:57:31 +0000 |
---|---|---|
committer | Louis Pilfold <louis@lpil.uk> | 2024-03-26 13:57:31 +0000 |
commit | c2dcbe0f25a3e8bd60a4ccf377bbdd47f4794871 (patch) | |
tree | 18862644ee2dada0a926392b11e606bb0d2262f7 /src/content/chapter5_advanced_features/lesson06_externals/en.html | |
parent | ccf75d2c362ac8e4dcd12c781f6e1eafd0064813 (diff) | |
download | tour-c2dcbe0f25a3e8bd60a4ccf377bbdd47f4794871.tar.gz tour-c2dcbe0f25a3e8bd60a4ccf377bbdd47f4794871.zip |
Document opaque types
Closes https://github.com/gleam-lang/language-tour/issues/63
Diffstat (limited to 'src/content/chapter5_advanced_features/lesson06_externals/en.html')
-rw-r--r-- | src/content/chapter5_advanced_features/lesson06_externals/en.html | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/src/content/chapter5_advanced_features/lesson06_externals/en.html b/src/content/chapter5_advanced_features/lesson06_externals/en.html new file mode 100644 index 0000000..8815fa7 --- /dev/null +++ b/src/content/chapter5_advanced_features/lesson06_externals/en.html @@ -0,0 +1,25 @@ +<p> + Sometimes in our projects we want to use code written in other languages, most + commonly Erlang and JavaScript, depending on which runtime is being used. + Gleam's <em>external functions</em> and <em>external types</em> allow us to + import and use this non-Gleam code. +</p> +<p> + An external type is one that has no constructors. Gleam doesn't know what + shape it has or how to create one, it only knows that it exists. +</p> +<p> + An external function is one that has the <code>@external</code> attribute on + it, directing the compiler to use the specified module function as the + implementation, instead of Gleam code. +</p> +<p> + The compiler can't tell the types of functions written in other languages, so + when the external attribute is given type annotations must be provided. Gleam + trusts that the type given is correct so an inaccurate type annotation can + result in unexpected behaviour and crashes at runtime. Be careful! +</p> +<p> + External functions are useful but should be used sparingly. Prefer to write + Gleam code where possible. +</p> |