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

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?

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
saveman71
Hello ! We want new/edit form pages to POST/PUT to their own URL rather than the resources REST defaults (post /things, put /things/:id)...
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