mrageh

mrageh

Why do structs accept keyword lists as args and not maps?

Hi

I’ve been learning Elixir lately and there’s something that’s been confusing me.

An Elixir struct accepts a keyword list as it’s argument, yet it does not behave
like a keyword list. In fact it behaves almost identical to a map.

Why does a struct accept keyword lists as it’s argument if it’s got more in common
with a map?

First 6 of 6 Posts Switch mode

NobbZ

NobbZ

Structs are maps underneath, they just have an extra key :__struct__ that points to their module, and also keys are only allowed to be atoms.

But what do you mean by “An Elixir struct accepts a keyword list as it’s argument”? A struct does not take any arguments at all…

kokolegorille

kokolegorille

The struct command does… but probably because it’s simpler to pass Keyword as function argument.

struct Page, title: "koko"
%CmsEx.Cms.Page{
  __meta__: #Ecto.Schema.Metadata<:built, "pages">,
  children: #Ecto.Association.NotLoaded<association :children is not loaded>,
  depth: nil,
  id: nil,
  inserted_at: nil,
  lft: nil,
  parent: #Ecto.Association.NotLoaded<association :parent is not loaded>,
  parent_id: nil,
  rgt: nil,
  title: "koko",
  updated_at: nil
}
NobbZ

NobbZ

Yeah, struct/2 and defstruct/1 do so, because its easier to deal with in the AST and also a lot easier to write I assume.

Compare defstruct %{a: "", b: :c} vs. defstruct A: "", b: :c.

But at least for struct/2 any enumerable is allowed according to the typespecs. So struct Page, %{title: "koko"} is as valid as struct Page, title: "koko" is.

mrageh

mrageh OP

In order to create a struct you have to pass it a keyword list:

defmodule User do
  defstruct [name: "", age: nil]
end

Why do we do that and why don’t we pass in maps, since Structs are really maps.
For example is_map(%User{}) would return true. But then Structs accept keyword
lists instead of maps, which is kind of weird I think.

mrageh

mrageh OP

Thanks that makes sense!

peerreynders

peerreynders

You defining it (at compile time), not creating it (at runtime).

defmodule User do
  defstruct [name: "", age: nil] # defining struct at compile time
  
  def new(name, age \\ nil) do
    %User{age: age, name: name} # creating struct at run time
  end
end
— All posts loaded —

Where Next?

Trending in Questions Top

jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
silverdr
Using Phoenix.LiveView.TagEngine as an EEx.Engine is deprecated! To compile HEEx, use Phoenix.LiveView.TagEngine.compile/2 instead. Sta...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
michallepicki
I am using Oban and occasionally, shortly after a deployment, a handful of jobs can fail because of dependency on other parts of the syst...
New
rahultumpala
Hello, I have an Elixir backend that implements a custom protocol over TCP. I want to load test the backend and assess the performance o...
New

Other Trending Topics Top

kraleppa
If you’ve ever had to debug a BEAM node you know it can be a painful process. Parsing raw data, or dealing with clutter often gets in the...
New
JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge &amp; Solve. They are GUI (Emerge) and State management (S...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New

We're in Beta

About us Mission Statement