beatscode

beatscode

Convert json to defstruct definition

I’m porting an application written in go to elixir. I’m just starting to learn elixir. In go it is easier to convert your data to structs to easily get properties from objects. I’d like to do the same in elixir. I’d like to convert a json payload to a set of defstructs. I see the docs on defstruct but I am wondering what developers do when the defstruct needed is too tedious to write. Are there any tools to convert a json payload to a defstruct definition?
I see the struct function but I would still need to write out the defstruct definition to make that function work. I am also using poison to convert the payload to a map but I’d like to use custom types instead.

First 9 of 9 Posts Switch mode

NobbZ

NobbZ

Why do you need it to be a struct? Can’t you use a map instead?

I do usually try to avoid to create struct-only modules, so unless you do not want to create related functions, using a plain map might be so much easier.

beatscode

beatscode OP

I was looking at using guards with functions but doesn’t seem like I can use Map.get inside the guard.
I would like to create related functions as well. Can I not make related functions with structs?

NobbZ

NobbZ

You can’t access maps (structs are just sugar over maps) in a guard, but you can match on them in the function head or in a case-clause or using the match operator.

I do not understand that question.

beatscode

beatscode OP

If you’re saying that its easier to use map structures instead, I’m confused as to how one would try to reason about these maps and think in terms of concrete types. In order to create concrete types I’d have to create defstructs.

I do usually try to avoid to create struct-only modules, so unless you do not want to create related functions, using a plain map might be so much easier.

I didn’t quite understand this statement, which prompted my question. You mentioned not creating related functions. Under what conditions can I not make related functions?

I’ll look into the case syntax

gon782

gon782

I made this some time ago just for shits and giggles: GitHub - GoNZooo/struct_provider: Macro(s) to convert data into struct definitions in Elixir · GitHub

It takes JSON input and creates structs from it. Note that I consider it pretty useless, but if you wanna make something internal from it that’s actually usable for your team, feel free to take and and work out some kinks. As an example of a deficiency, it doesn’t define new modules from nested JSON data, so you’ll only get the top level. The from_json version would probably be a good place to start with and then downloading JSON data to disk as schema for input.

Edit: The reason I find it pretty useless is fundamentally that it’s not backed by statically checked types. If it was, you could know whether your assumptions changed from under you much easier, so then you could pull the data straight from HTTP and generate the types without having to care, because the compiler would always tell you anyway.

NobbZ

NobbZ

I said, that I avoid creating defstruct only modules. If though I have related functions for some type, I do create a module and a defstruct as well. Thats it.

Also JSON doesn’t give you any guarantee about types, so why care?

Creating and maintaining depply nested structs is a burden and comes with a technical debt, when in fact all you need to rely on is the contract that there will be certain fields and you never care for the rest.

This is especially true when you have a JSON which constantly changes its shape and you need to find out the proper type first by checking a certain key in it.

anthonator

anthonator

Since your example was to use Map.get in your guard it makes me think you might be able to pattern match instead.

def my_func(%{ data: data }) when is_map(data) do
  ...
end
anthonator

anthonator

I completely agree with this.

OvermindDL1

OvermindDL1

If using Poison you can have it auto-convert a JSON string to a specific struct(s). You’d still need to write your structs, but once done then you have a confirmed structure.

— All posts loaded —

Where Next?

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
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

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
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
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

We're in Beta

About us Mission Statement