isaacsanders
I find myself coming back to a handful of types that I have recently made modules for, and I believe that others have made libraries to work with, and I wanted to see if we could have a discussion about the appropriate names for some types.
The types I keep on encountering and the names that I have chosen for them:
@typedoc """
A nullable value.
"""
@type optional(a) :: a | nil when a: term()
@typedoc """
The result of an action that can unambiguously fail, e.g. `Map.fetch/2`
"""
@type maybe(a) :: {:ok, a} | :error when a: term()
@typedoc """
The result of an action that fails multi-modally and may be handled per failure mode.
"""
@type either(x, a) :: {:ok, a} | {:error, x} when a: term(), x: term()
What do y’all think?
Where Next?
Trending in Discussions
Other Trending Topics
Latest on Elixir Forum
Sponsor Spotlight
Producing high quality Elixir screencasts since 2017.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #blog-post
- #ai
- #phoenix_html
- #iex
- #elixirconf-us
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #hex
- #security
- #metaprogramming
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Error tracking, logs, uptime, and Just Enough APM. Built for developers.
Bringing learning, work and compliance together since 1987.
Producing high quality Elixir screencasts since 2017.
The deployment platform built for Elixir: PaaS ease, VPS control.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"
Showing Posts 1 to 5- Show Best Posts
- Show All (oldest first)
- Show All (newest first)
jeremyjh
I don’t think
maybeoreitherare the most intuitive names for non-Haskellers. I call youreitheroneresultin my projects.By the way, Dialyzer doesn’t unify type variables so that signature is functionally no different from
Or the more idiomatic
Exceptional calls it a TaggedStatus but doesn’t define a
@typefor it that I could find.isaacsanders
Are you saying there is no functional value to using parameters in types in Elixir?
jeremyjh
I can’t think of any, other than it could be shorter in some cases. Sometimes I think it’s good documentation to use the same type var where it should be unified, but it tends to mislead people about Dialyzer’s capability.
Qqwy
I don’t think that these newly defined types make a lot of sense, because it is an extra layer of indirection a newcomer has to get used to when encountering
either(x, y)in the return type of a function.I do think that it would make sense if we somehow standardize the naming for thesee things, however. There are a couple of libraries that work on structures of the shape
{:ok, a} | {:error, b}(and the less common{:ok, a} | :error), but there is no real consensus on the naming of these structures.I think that names like ‘Result Tuple’, ‘OK Tuple’, ‘Error Tuple’, ‘Success Tuple’ are frequently used (by e.g. ok_jose, if_ok, ok, fun_land) but they are not the only ones. I know that exceptional uses ‘tagged status’ to indicate these structures, and maybe there are even others.
For instance, I’m not sure if Witchcraft also defines Maybe/Result monads based on tuples of this specific format, or not.
OvermindDL1
It defines custom structures. It’s a library of design, not of efficiency.
(Well not witchcraft itself as it’s a library to build such things, but the ones built on it is.)