ilya-kolpakov

ilya-kolpakov

Generating structs from constructor functions

Suppose one wants to have a bunch of structs that represent API requests. Requests have parameters and it should be possible to validate parameters when constructing the structs. This use case would be completely covered if one could specify a structure by simply providing an appropriate (validating) constructor.

Here is is somewhat contrived example:

defmodule Orders do
  import SuperStruct # hypothetical
  defsstruct market(id, quantity, type, exchange \\ nil, fill_or_kill \\ false)
  when is_binary(id) and is_int(quantity) and type in [:buy, :sell]
  and (is_binary(exchange) or is_nil(exchange)) and is_boolean(fill_or_kill)

  defsstruct limit(id, quantity, type, price, exchange \\ nill, valid_until \\ nil) #...
end 

# Create an order

# Would be nice to be able to use keyword syntax for all params
order = Orders.Market.new(id: "GOOG", quantity: 100, type: :buy)

# Processing code

case order do
    %Orders.Market{} -> # market order
    %Orders.Limit{} -> # limit order
end
def process(%Orders.Market{}=o), do: #...
def process(%Orders.Limit{}=o), do: #...

It looks like it should be possible to come up with macros that would parse the signatures and generate the appropriate struct modules (e.g. modules having custom __struct__ methods). I am wondering if there is a library for doing something similar or maybe someone looked into something similar in the past.

I briefly looked at construct, exconstructor and struct_constructor packages and I think their focus is slightly different. It looks like they all provide nice field definition macros but do not aim at parsing/repackaging constructors. Clearly, there are pros and cons to both approaches.

First 2 of 2 Posts Switch mode

axelson

axelson

Scenic Core Team

I think you’re looking for a library such as params by @vic. It helps you to validate that the parameters that you’re receiving are what you expect.

OvermindDL1

OvermindDL1

Or perhaps the algae library.

— All posts loaded —

Where Next?

Trending in Discussions Top

AstonJ
As the title says, please share what you’ve been up to with Elixir. Whether that’s been learning it, looking into it, making stuff with i...
2977 91561 914
New
byu
@chrismccord : I just saw the Extract AGENTS.md from Phoenix.new into phx.new generator commit to the phoenix project. My initial shotgu...
New
arcanemachine
I was working on an Ecto migration and I needed a timestamp. So, for the nth time, I looked up the different data types for timestamps, a...
New
AstonJ
Just a general thread to post chat/news/info relating to AI/ML stuff that may be relevant for Nx now or in the future. Got anything to sh...
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
juhalehtonen
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New
alexslade
Fly’s CEO posted this recently - Turn And Face The Strange · The Fly Blog It says that Fly is going all-in on sprites, which is a worry ...
New

Other Trending Topics Top

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 & 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
akoutmos
@hugobarauna and I (Alex Koutmos) have been hard at work on writing a book on Nerves that takes you from simply blinking LEDs to building...
New
bjorng
We want to introduce a new native datatype to Erlang: native records. Although replacing all tuple records with native records is not our...
New

We're in Beta

About us Mission Statement