Giter Club home page Giter Club logo

json_struct's Introduction

JsonStruct

JsonStruct is a elixir library that takes care of implementing the Jason.Encoder Protocol for a struct.

It also allows for easy renaming of keys and gives you the option to add your own encoding/decoding function for each field.

defmodule Message do
  use JsonStruct

  json_struct do
    field :to, json: "to"
    field :id, json: "msgId"

    field :message,
      json: "msg",
      encode: &String.upcase/1,
      decode: &String.downcase/1
  end
end
msg = %Message{id: "abcd", to: "José", message: "I love Elixir!"} |> Jason.encode!()
msg == ~s|{"msg":"I LOVE ELIXIR!","msgId":"abcd","to":"José"}|

Installation

If available in Hex, the package can be installed by adding json_struct to your list of dependencies in mix.exs:

def deps do
  [
    {:json_struct, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/json_struct.

Inspiration

The library is inspired by Go struct tags and the rename field attribute of serde. The basic structure of the macro is inspired by ejpcmac/type_struct.

json_struct's People

Contributors

hdahlheim avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.