zhangyiss/toml11
1
0
Fork 0
mirror of https://github.com/ToruNiina/toml11.git synced 2025-09-16 16:28:09 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme and add proposal

Browse Source
This commit is contained in:
ToruNiina
2017-05-13 15:14:16 +09:00
parent 36199498b4
commit be9ea157a7
2 changed files with 72 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -42,8 +42,7 @@ If there are syntax error in the toml file,
#### toml::get()
Then you can obtain the various value from the `data` using `toml::get` function
no matter what the value type is.
Then you can obtain the various value from the `data` using `toml::get` function.
``` cpp
const auto answer = toml::get<std::int64_t>(data.at("answer"));
@@ -60,13 +59,20 @@ const auto vc = toml::get<std::vector<int>>(data.at("numbers"));
const auto ls = toml::get<std::list<int>>(data.at("numbers"));
const auto dq = toml::get<std::deque<int>>(data.at("numbers"));
// if size of data.at("numbers") is larger than 3, it will throw toml::type_error.
// because std::array is not resizable.
const auto ar = toml::get<std::array<int, 3>>(data.at("numbers"));
```
If the type you passed as a template parameter is incorrect,
it will throw `toml::type_error`.
#### value\_t and toml::value::type()
``` cpp
const auto wrong1 = toml::get<bool>(data.at("integer")); // exception thrown!
const auto wrong2 = toml::get<float>(data.at("integer")); // ditto
const auto wrong3 = toml::get<toml::Datetime>(data.at("array")); // ditto
```
#### toml::value\_t
When you don't know the exact type of toml-value, you can get `enum` type from
`toml::value`.
@@ -79,10 +85,10 @@ std::vector<int> a;
const auto t = data.at("something").type();
switch(t)
{
case toml::value_t::Integer: i = toml::get<int>(data.at("something"));
case toml::value_t::Float : d = toml::get<double>(data.at("something"));
case toml::value_t::String : s = toml::get<std::string>(data.at("something"));
case toml::value_t::Array : a = toml::get<std::vector<int>>(data.at("something"));
case toml::value_t::Integer: i = toml::get<int>(data.at("something")); break;
case toml::value_t::Float : d = toml::get<double>(data.at("something")); break;
case toml::value_t::String : s = toml::get<std::string>(data.at("something")); break;
case toml::value_t::Array : a = toml::get<std::vector<int>>(data.at("something")); break;
default : throw std::runtime_error("unexpected type : " + stringize(t));
}
```