https://github.com/aeronavery/zig-toml

A TOML parser written in Zig
https://github.com/aeronavery/zig-toml

Last synced: about 1 month ago
JSON representation

A TOML parser written in Zig

• Host: GitHub
• URL: https://github.com/aeronavery/zig-toml
• Owner: aeronavery
• License: mit
• Created: 2019-07-19T04:15:56.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-04T13:58:45.000Z (8 months ago)
• Last Synced: 2024-05-18T19:31:55.449Z (7 months ago)
• Language: Zig
• Size: 37.1 KB
• Stars: 98
• Watchers: 3
• Forks: 20
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-zig - aeronavery/zig-toml
• awesome-zig - zig-toml🗒️A TOML parser written in Zig

README

        
[![Build Status](https://github.com/aeronavery/zig-toml/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/aeronavery/zig-toml/actions/workflows/unit_tests.yml)

# zig-toml

A TOML parser written in Zig targeting [TOML v0.5.0](https://github.com/toml-lang/toml). The end goal is for the program to be robust, with no crashing given any situation. Though, in its current state this program is probably far from that goal.

There is currently a lack of documentation but the tests contained should give enough of an idea on how to use this.

[Quickstart Guide](https://github.com/darithorn/zig-toml/wiki/Quickstart-Guide)

## Zig Version Support

This table shows the project's current compatibility status with zig:

| Zig Version | Status |

| -- | -- |

| [0.11.0](https://ziglang.org/documentation/0.11.0/) | ✅ Supported |

| [0.10.1 and below](https://ziglang.org/documentation/0.10.1/) | ❌ Not Supported |

## Features

- [x] Tables

- [x] Keys (all kinds)

- [x] Single-line strings

- [x] Integers

- [x] Booleans

- [x] Arrays

- [x] Comments

- [x] Floats

- [x] Hexadecimal, octal, and binary numbers

- [ ] Multi-line strings

- [ ] String escapes

- [x] Inline tables

- [x] Array of tables

- [ ] Time and date

## Building and Usage

This library is self-contained and requires no dependencies.

To build simply run `zig build` and that will output a file called `libtoml.a` that you can link with your program.

If you want to run the tests then use the `zig build test` command.