Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/williamthome/exneus
An incredibly flexible and performant JSON parser, generator and formatter for Elixir
https://github.com/williamthome/exneus
elixir elixir-library format-json json jsonformatter jsongenerator jsonparser minify minify-json mix otp otp-library prettify pretty-json
Last synced: 3 months ago
JSON representation
An incredibly flexible and performant JSON parser, generator and formatter for Elixir
- Host: GitHub
- URL: https://github.com/williamthome/exneus
- Owner: williamthome
- License: apache-2.0
- Created: 2024-08-07T19:32:53.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-26T10:06:56.000Z (3 months ago)
- Last Synced: 2024-09-30T09:01:36.994Z (3 months ago)
- Topics: elixir, elixir-library, format-json, json, jsonformatter, jsongenerator, jsonparser, minify, minify-json, mix, otp, otp-library, prettify, pretty-json
- Language: Elixir
- Homepage: https://hex.pm/packages/exneus
- Size: 1.21 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Exneus
[](https://github.com/williamthome/exneus/actions)
[](https://github.com/williamthome/exneus/actions/workflows/ci.yml)
[](https://elixir-lang.org/)
[](http://www.erlang.org)
[](https://github.com/williamthome/exneus/releases/latest)
[](https://hex.pm/packages/exneus)
[](https://hexdocs.pm/exneus/)
[](https://hex.pm/packages/exneus)
[](https://github.com/williamthome/exneus/blob/main/LICENSE)
[](https://github.com/williamthome/exneus/commits/main)
An incredibly flexible and performant JSON parser, generator and formatter for Elixir.
Exneus is a wrapper for Elixir of [Euneus](https://github.com/williamthome/euneus),
an Erlang library built on the top of the new [OTP json module](https://erlang.org/documentation/doc-15.0-rc3/lib/stdlib-6.0/doc/html/json.html).
Both encoder and decoder fully conform to [RFC 8259](https://datatracker.ietf.org/doc/html/rfc8259)
and [ECMA 404](https://ecma-international.org/publications-and-standards/standards/ecma-404/) standards
and are tested using [JSONTestSuite](https://github.com/nst/JSONTestSuite).
Further explanation and examples are available at [hexdocs](https://hexdocs.pm/exneus).
## Installation
```elixir
def deps do
[
{:json_polyfill, "~> 0.1"}, # Required only for OTP < 27
{:exneus, "~> 0.1"}
]
end
```
## Basic usage
```elixir
iex(1)> Exneus.encode!(%{name: "Joe Armstrong", age: 68, nationality: "British"})
"{\"name\":\"Joe Armstrong\",\"age\":68,\"nationality\":\"British\"}"
iex(2)> Exneus.decode!(v(1))
%{"age" => 68, "name" => "Joe Armstrong", "nationality" => "British"}
```
## Encode
Functions that provide JSON encoding:
- `Exneus.encode!/2`
- `Exneus.encode_to_iodata!/2`
## Decode
Functions that provide JSON decoding:
- `Exneus.decode!/2`
## Stream
Functions that provide JSON decode streaming:
- `Exneus.decode_stream_start!/2`
- `Exneus.decode_stream_continue!/2`
- `Exneus.decode_stream_end!/1`
## Format
Functions that provide JSON formatting:
- `Exneus.minify/1`
- `Exneus.minify_to_iodata/1`
- `Exneus.format/2`
- `Exneus.format_to_iodata/2`
## Benchmark
See [BENCHMARK.md](benchmark/BENCHMARK.md) for more information.
### Encode benchmark
```console
##### With input Blockchain #####
Name ips
euneus 36.95 K
json (OTP) 35.85 K - 1.03x slower +0.83 μs
Exneus 35.71 K - 1.03x slower +0.94 μs
jiffy 34.70 K - 1.06x slower +1.76 μs
Jason 26.75 K - 1.38x slower +10.32 μs
thoas 16.40 K - 2.25x slower +33.92 μs
jsone 15.52 K - 2.38x slower +37.38 μs
jsx 4.21 K - 8.77x slower +210.29 μs
JSON 3.88 K - 9.52x slower +230.47 μs
Memory usage statistics:
Name average
euneus 84.20 KB
json (OTP) 82.66 KB - 0.98x memory usage -1.53125 KB
Exneus 84.13 KB - 1.00x memory usage -0.06250 KB
jiffy 7.79 KB - 0.09x memory usage -76.40625 KB
Jason 78.32 KB - 0.93x memory usage -5.87500 KB
thoas 89.41 KB - 1.06x memory usage +5.22 KB
jsone 178.56 KB - 2.12x memory usage +94.37 KB
jsx 397.30 KB - 4.72x memory usage +313.11 KB
JSON 481.30 KB - 5.72x memory usage +397.11 KB
```
### Decode benchmark
```console
##### With input Blockchain #####
Name ips
json (OTP) 18.79 K
euneus 18.06 K - 1.04x slower +2.16 μs
Exneus 17.68 K - 1.06x slower +3.34 μs
Jason 15.16 K - 1.24x slower +12.74 μs
jsone 13.82 K - 1.36x slower +19.17 μs
jiffy 12.76 K - 1.47x slower +25.15 μs
thoas 11.89 K - 1.58x slower +30.89 μs
jsx 4.93 K - 3.81x slower +149.64 μs
JSON 2.43 K - 7.74x slower +358.48 μs
Memory usage statistics:
Name average
json (OTP) 35.95 KB
euneus 36.93 KB - 1.03x memory usage +0.98 KB
Exneus 37.05 KB - 1.03x memory usage +1.09 KB
Jason 51.63 KB - 1.44x memory usage +15.67 KB
jsone 131.70 KB - 3.66x memory usage +95.74 KB
jiffy 1.55 KB - 0.04x memory usage -34.40625 KB
thoas 51.41 KB - 1.43x memory usage +15.46 KB
jsx 315.84 KB - 8.78x memory usage +279.89 KB
JSON 1042.65 KB - 29.00x memory usage +1006.69 KB
```
## Sponsors
If you like this tool, please consider [sponsoring me](https://github.com/sponsors/williamthome).
I'm thankful for your never-ending support :heart:
I also accept coffees :coffee:
[](https://www.buymeacoffee.com/williamthome)
## License
Copyright (c) 2024 [William Fank Thomé](https://github.com/williamthome)
Exneus is 100% open-source and community-driven. All components are
available under the Apache 2 License on [GitHub](https://github.com/williamthome/exneus).
See [LICENSE.md](LICENSE.md) for more information.