How to check if an Elixir map has a given key in a guard?
Join Elixir newsletter
Subscribe to receive Elixir news to your inbox every two weeks.
Expand your skills
Download free e-books, watch expert tech talks, and explore open-source projects. Everything you need to grow as a developer - completely free.
Today's Advent of Code puzzle inspired me to create this TIL. It may sound trivial, but in fact, it's tricky if you are unfamiliar with the nuances of guards' functioning.
Usually, you would write Map.has_key?(map, key) , but it's forbidden in guards since, in them, you can only use expressions from a strictly limited list.
** (CompileError) iex:11: cannot invoke remote function Map.has_key?/2 inside guards
(elixir 1.13.1) src/elixir_fn.erl:17: anonymous fn/4 in :elixir_fn.expand/4
(stdlib 3.17) lists.erl:1358: :lists.mapfoldl/3
(elixir 1.13.1) expanding macro: Kernel.|>/2What about in?
Unfortunately, unlike in languages like Python or Javascript, Elixir's inmacro doesn't check for key inclusion in a given map.
is_map_key/2 for the help
Elixir 1.10.0 introduced a new function allowed in guard tests - is_map_key/2 .
Let's see an example:
iex(1)> variables = %{"a" => 5}
...(1)> translated = Enum.map(["a", "b"], fn
...(1)> name when is_map_key(variables, name) -> variables[name]
...(1)> name -> name
...(1)> end)
[5, "b"]This code replaces all occurrences of known variable names in a given list with their values.
You probably don't need an is_map_key/2
Constructions like the above are rather rare. In most cases, you can get the job done using good old pattern matching.
If you already know which key you are looking for, a much better option is to create multiple function clauses:
def has_user?(%{user: _}), do: true
def has_user?(_), do: falseRelated posts
Dive deeper into this topic with these related posts
You might also like
Discover more content from this category
So you don’t know what’s the type of struct you’re passing somewhere? Maybe it can be one of few types and you have to distinguish them? Or any other reason… But it’s about checking the struct type. Just use one of the coolest Elixir features - pattern matching!
Each of us had a situation, where we had to invoke a few, same commands each time. Making it once is not that problematic, but when we are supposed to repeat given operations, it may be better just to create one function that will handle it all.
TLDR: With jest-extended package you can write: expect([...set]).toIncludeSameMembers([value1, value2]);. If you are looking to a native, but longer solution scroll down a bit.