Fl4m3Ph03n1x

Fl4m3Ph03n1x

How to not encode nil field from Struct using Jason

Background

I have a TypedStruct with an optional field, :rank. This field is sometimes present and sometimes not.

  @derive Jason.Encoder
  typedstruct enforce: true do
    @typedoc "An order."

    field(:item_id, String.t())
    field(:rank, non_neg_integer(), enforce: false)
  end

The ideal situation here would be to generate the struct without the field, should the :rank parameter be missing. However, since I am dealing with structs, this is not possible, so I have to contempt with the nil value representing the absence of :rank.

The problem here is that when I use Jason.encode(...) , I am going to get a "rank": null in the result json object. I really don’t want this.

Question

Is there an option in Jason that allows me to not encode nil values, other than manually implementing the Encode Protocol myself?

Marked As Solved

brettbeatty

brettbeatty

other than manually implementing the Encode Protocol myself

From the “Deriving” section of the Jason.Encoder docs, there doesn’t appear to be a way.

However, Jason.Encode.map/2 appears to make it incredibly simple to implement Jason.Encoder on your own maps. It seems like something like this would do the trick:

defimpl Jason.Encoder do
  def encode(value, opts) do
    value
    |> Map.from_struct() # or take exactly the keys you want
    |> Map.reject(fn {_k, v} -> is_nil(v) end) # since 1.13
    |> Jason.Encode.map(opts)
  end
end

Where Next?

Popular in Questions Top

joaquinalcerro
Hi there, I am working with Ecto-Postgresql and I need to call all of the records from a specific table but the table has 40,000 records...
New
Qqwy
Original source of discussion: This topic on the Pragmatic Programmers’ Functional Web Development with Elixir, OTP, and Phoenix forum. ...
New
vonH
When I run the Plug and I recompile I wind up having to use Ctrl C to quit iex and start again. Witht the help of rlwrap I can use the cu...
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
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
Fl4m3Ph03n1x
About me? ( if you have nothing better to do than reading about some random guy in the internet :stuck_out_tongue: ) Hello all, this is ...
New
shijith.k
I am trying to start a new phoenix project with elixir 1.9, but mix phx.new does not work. It says that ** (Mix) The task "phx.new" could...
New

Other popular topics Top

nobody
Hi! In PHP: $_SERVER[‘SERVER_ADDR’] - in Elixir? Searched the docs for ip address and the web, no good results. Thanks!
New
JakeBecker
TL;DR: I’ve just released an implementation of Microsoft’s IDE-independent Language Server Protocol for Elixir. It adds language support ...
1144 54921 245
New
sen
Hi All, I set a environment variables in dev.exs , like below code. when i start server, how can i set the ${enable} value? thanks. d...
New
axelson
This post is a wiki (feel free to hit the edit button near the bottom right of this post to add your own changes!) This post collects co...
239 49084 226
New
bsollish-terakeet
Credo is smart enough to check for (something like) this: assert length(the_list) == 0 with this response: Checking if an enum is empt...
New
jason.o
In the code below, if the create action is not set to accept “extra_key” as an input, it errors out with a message shown above. Is there ...
New

We're in Beta

About us Mission Statement