sodapopcan

sodapopcan

Can someone explain `do` syntax in a non hand-holding way?

I’m wondering exactly what a do block is.

Is it a closure? Is it a procedure? Is it an anonymous function? Is it a lambda? Is it something else?

Is it more useful to think of an Elixir do block as a Ruby block or as Haskell’s do notation or maybe a combination of the two? Or neither!!? Maybe even a JS closure?

Is it some mutant variation of all of that?? Or maybe none of that!???

I do (haha, get it?) have some intuition about this and have read the meta-programming part of the Elixir guides (which calls it an expression but, like, it’s really a series of expressions… no?) and I’m just looking for some insightful—or even just fun—responses from people in the community, if anyone is willing.

What I already think I know:

  • do is syntactic sugar for calling the, uh, “block of code” provided to the :do key of a keyword list arg provided to a macro
  • That’s it!

Thank you!!

Most Liked

josevalim

josevalim

Creator of Elixir

In a nutshell, do-end blocks is a syntax sugar for a :do keyword list.

if CONDITION do
  EXPR
end

is the same as:

if CONDITION, do: (EXPR)

You can see this by calling quote as shown by @ityonemo. Since keyword lists are just data structures, do-blocks end-up being just data structures too. It doesn’t need to be given only to macros, regular functions can also use and match on it, some helpers in Phoenix.HTML do so, but their usage is indeed more common with macros.

As a syntax sugar, they also allow some specific syntactical constructs, such as left -> right and other keywords (else, rescue, etc), but all of them can be written in the literal keyword syntax format too.

ityonemo

ityonemo

haha maybe I think I should break this down more carefully. A macro in elixir is a function that emits AST + “take the AST generated, right here in the code” (a bare function will drop its value, in that location, not the AST). So macros in the first are a function. Let’s consider the “def” macro.

We’ll look at it three ways:

quote do
  def foo, do: :bar 
end

which yields:

{:def, [context: Elixir, import: Kernel],
 [{:foo, [context: Elixir], Elixir}, [do: :bar]]}

and

quote do
  def foo do
     :bar
  end
end

which yields

{:def, [context: Elixir, import: Kernel],
 [{:foo, [context: Elixir], Elixir}, [do: :bar]]}

and

quote do
  def foo do
     :throwaway_statement
     :bar
  end
end 

which yields

{:def, [context: Elixir, import: Kernel],
 [
   {:foo, [context: Elixir], Elixir},
   [do: {:__block__, [], [:throwaway_statement, :bar]}]
 ]}

Note a) forms 1 and 2 are identical
and b) form 3 groups the two lines of the function into a block.

Why is that necessary? Because according to Kernel.def/2 documentation (https://hexdocs.pm/elixir/Kernel.html#def/2), the function half of the def macro must take TWO AST parameters. The first parameter is the name of the function (and also a list of arguments) and the second parameter is the contents of the function. So the only arity-consistent way of representing def is by grouping the AST for the body of the function into a block and labeling it as “do”. So the do “keyword” is just elixir’s cute way of saying "hey everything until the “end” keyword winds up in the block. And if you don’t want a block, you can just pass it as do:, which builds the keyword list manually and passes it into the def function without syntactic sugar.

One more important thing to note is that in elixir, lists, atoms, and two-tuples don’t need escaping, because they are identical to their AST, so that’s how when you do a one-liner the do: part of the code makes it into the macro without being converted into these strange tuple forms.

as for why it’s a keyword list, if you look further down the documentation, you can have other parts to the function code, for example catch or rescue blocks; if you do that, for example this code which is nonsensical:

quote do
  def foo do
     :bar
   catch
     :baz
   end
end

yields:

{:def, [context: Elixir, import: Kernel],
 [{:foo, [context: Elixir], Elixir}, [do: :bar, catch: :baz]]}

so other “segments” of the function can nicely wind up stuffed into an arity-2 statement. Likewise you can arbitrarily mix-and-match catches and rescues, because a keyword-list is what you are supposed to use when you have a maybe-ordered list of arbitrary things that can’t be a map because you can maybe have duplicates.

ityonemo

ityonemo

Just tried it. Mind blown. I mean, of course, what was I thinking, why wouldn’t that work??!. I promise not to use this power for evil.

Where Next?

Popular in Questions Top

lanycrost
Hi everyone! I need implement if…else if…else condition from my elixir code, and anymore of this control flow structures not work proper...
New
belgoros
I’m not a pro in using Regex and can’t figure out why the following behaviour happens, especially if we take into account the difference ...
New
jononomo
I am trying to figure out how Mix knows whether the environment is test, dev, or prod -- where is this set? Thanks.
New
vonH
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
New
romenigld
I am trying to run a deploy with docker and I successfully runned with this command: docker build -t romenigld/blog-prod . but when I t...
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
Phillipp
Hey, I have a NanoPi-M3 and try to install Elixir on their Ubuntu image. I followed the Raspberry Pi installation instructions from the ...
New
mathew4509
I have a list say x = ["23gh", "56kh", "97mh"] I would like to pass each element to Val in each iteration. Say, in iteration 1 -------...
New
fayddelight
I tried installing elixir 1.11.2 erlang 23.3.4 via asdf in my zsh shell. Enabled the versions locally and globally. When I list them ...
New
ovidiubadita
Hey all, I discovered Elixir and I love it. I always wanted to learn a functional programming and I intended to go for Haskell, but afte...
New

Other popular topics Top

9mm
I am constructing a JSON object (map) and I need to conditionally set a field. I’m trying to write proper elixir-way code… and I’m at a l...
New
Tee
can someone please explain to me how Enum.reduce works with maps
New
Jim
As a follow up to my earlier question: I have the code compiling and running but not getting a successful login from the rest server. ...
New
script
If I have a string “1000 cfu/ml” . I want to remove the characters and / and space . So the string is like this "1000" What is the ...
New
chrismccord
As promised, the first release candidate of Phoenix 1.3.0 is out! This release focuses on code generators with improved project structure...
New
shahryarjb
Hello, I have map which I want to convert it to string like this: the map: %{last_name: "tavakkoli", name: "shahryar"} the string I ne...
New
fireproofsocks
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? https://hexdocs.pm/ecto/Ecto.Repo.h...
New
electic
Hi, I am new to Elixir. I am trying to use the DateTime component to insert a date into MySQL however the there seems to be no way to fo...
New
skosch
To my knowledge, put_in, Map.update etc. all have the one limitation of not automatically creating intermediate keys when needed (for exa...
New
Nvim
Elixir appears to be a superior language to Python. I don’t see any advantage of Python over Elixir. Are there any?
New

We're in Beta

About us Mission Statement