AuroraMiddleware/toml11
1
0
Fork 0
mirror of https://github.com/ToruNiina/toml11.git synced 2024-09-19 15:19:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: update exception section in README (fix #107)

Browse Source
This commit is contained in:
ToruNiina 2020-03-23 20:57:05 +09:00
parent c259456282
commit ea87f92358
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1424,7 +1424,7 @@ const toml::source_location loc = v.location();
## Exceptions
All the exceptions thrown by toml11 inherits `toml::exception` that inherits
The following `exception` classes inherits `toml::exception` that inherits
`std::exception`.
```cpp
@ -1451,6 +1451,16 @@ struct exception : public std::exception
It represents where the error occurs.
`syntax_error` will be thrown from `toml::parse` and `_toml` literal.
`type_error` will be thrown from `toml::get/find`, `toml::value::as_xxx()`, and
other functions that takes a content inside of `toml::value`.
Note that, currently, from `toml::value::at()` and `toml::find(value, key)`
may throw an `std::out_of_range` that does not inherits `toml::exception`.
Also, in some cases, most likely in the file open error, it will throw an
`std::runtime_error`.
## Colorize Error Messages
By defining `TOML11_COLORIZE_ERROR_MESSAGE`, the error messages from