Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimmiebergmann/mini-yaml
Single header YAML 1.0 C++11 serializer/deserializer.
https://github.com/jimmiebergmann/mini-yaml
cpp deserialize mini-yaml parser parsing serialization serializer yaml
Last synced: about 2 months ago
JSON representation
Single header YAML 1.0 C++11 serializer/deserializer.
- Host: GitHub
- URL: https://github.com/jimmiebergmann/mini-yaml
- Owner: jimmiebergmann
- License: mit
- Created: 2018-01-21T16:52:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T13:23:57.000Z (about 1 year ago)
- Last Synced: 2024-02-01T09:53:05.302Z (5 months ago)
- Topics: cpp, deserialize, mini-yaml, parser, parsing, serialization, serializer, yaml
- Language: C++
- Homepage:
- Size: 896 KB
- Stars: 204
- Watchers: 6
- Forks: 38
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-cpp - mini-yaml - Single header YAML 1.0 C++11 serializer/deserializer. [MIT] (Yaml)
- fucking-awesome-cpp - mini-yaml - Single header YAML 1.0 C++11 serializer/deserializer. [MIT] (Yaml)
- awesome-cpp-completed - mini-yaml - Single header YAML 1.0 C++11 serializer/deserializer. [MIT] (Yaml)
- awesome-cpp - mini-yaml - Single header YAML 1.0 C++11 serializer/deserializer. [MIT] (Yaml)
- awesome-cpp - mini-yaml - Single header YAML 1.0 C++11 serializer/deserializer. [MIT] (Yaml)
- awesome-cpp-completed - mini-yaml - Single header YAML 1.0 C++11 serializer/deserializer. [MIT] (Yaml)
- awesome-cpp - mini-yaml - Single header YAML 1.0 C++11 serializer/deserializer. [MIT] (Yaml)
- awesome-cpp - mini-yaml - Single header YAML 1.0 C++11 serializer/deserializer. [MIT] (Yaml)
README
# mini-yaml
[](https://github.com/jimmiebergmann/mini-yaml#build-status)
Single header YAML 1.0 C++11 serializer/deserializer.
## Quickstart
#### file.txt
```
key: foo bar
list:
- hello world
- integer: 123
boolean: true
```
#### .cpp
```cpp
Yaml::Node root;
Yaml::Parse(root, "file.txt");
// Print all scalars.
std::cout << root["key"].As() << std::endl;
std::cout << root["list"][0].As() << std::endl;
std::cout << root["list"][1]["integer"].As() << std::endl;
std::cout << root["list"][1]["boolean"].As() << std::endl;
// Iterate second sequence item.
Node & item = root[1];
for(auto it = item.Begin(); it != item.End(); it++)
{
std::cout << (*it).first << ": " << (*it).second.As() << std::endl;
}
```
#### Output
```
foo bar
hello world
123
1
integer: 123
boolean: true
```
See [Best practice](https://github.com/jimmiebergmann/mini-yaml#best-practice).
## Usage
Put [/yaml](https://github.com/jimmiebergmann/mini-yaml/blob/master/yaml) in your project directory and simply #include "[yaml/Yaml.hpp](https://github.com/jimmiebergmann/mini-yaml/blob/master/yaml/Yaml.hpp)".
See [examples/FirstExample.cpp](https://github.com/jimmiebergmann/mini-yaml/blob/master/examples/FirstExample.cpp) for additional examples.
## Best practice
Always use references when accessing node content, if not intended to make a copy. Modifying copied node wont affect the original node content.
See example:
```cpp
Yaml::Node root;
Yaml::Node & ref = root; // The content of "root" is not being copied.
ref["key"] = "value"; // Modifying "root" node content.
Yaml::Node copy = root; // The content of "root" is copied to "copy".
// Slow operation if "root" contains a lot of content.
copy["key"] = "value"; // Modifying "copy" node content. "root" is left untouched.
```
## Build status
Builds are passed if all tests are good and no memory leaks were found.
| Branch | Status |
| ------ | ------ |
| master | [](https://travis-ci.org/jimmiebergmann/mini-yaml) |
| dev | [](https://travis-ci.org/jimmiebergmann/mini-yaml)|
## Todo
- Parse/serialize tags(!!type).
- Parse anchors.
- Parse flow sequences/maps.
- Parse complex keys.
- Parse sets.