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

doc: explain about the type of the top-level value

Browse Source 
fix #120.
This commit is contained in:
ToruNiina
2020-06-21 14:00:03 +09:00
parent c22a3fd227
commit 2164fd39f7
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -119,6 +119,9 @@ const std::string fname("sample.toml");
const toml::value data = toml::parse(fname); const toml::value data = toml::parse(fname);
``` ```
As required by the TOML specification, the top-level value is always a table.
You can find a value inside it, cast it into a table explicitly, and insert it as a value into other `toml::value`.
If it encounters an error while opening a file, it will throw `std::runtime_error`. If it encounters an error while opening a file, it will throw `std::runtime_error`.
You can also pass a `std::istream` to the `toml::parse` function. You can also pass a `std::istream` to the `toml::parse` function.