ado/ssp
1
1
Fork 0
mirror of https://github.com/red0124/ssp.git synced 2025-01-23 13:05:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

minor changes to documentation

Browse Source
This commit is contained in:
ado 2021-01-03 19:51:54 +01:00
parent fb50e0b7d8
commit 6a74eb1d3f
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -408,17 +408,17 @@ p.try_next<int>()
# Rest of the library # Rest of the library
First of all, *type_traits.hpp* and *function_traits.hpp* contain many handy First of all, *type_traits.hpp* and *function_traits.hpp* contain many handy
traits used for the parser. Most of them are operating on tuples of elements traits used in the parser. Most of them are operating on tuples of elements
and can be utilized in projects. and can be utilized in projects.
## The converter ## The converter
**ss::parser** is used to manipulate on files. It has a builtin file reader, but **ss::parser** is used to manipulate on files. It has a builtin file reader, but
the conversions themselves are executed using **ss::converter**. the conversions themselves are done using the **ss::converter**.
To convert a string the **convert** method can be used. It accepts a c-string as To convert a string the **convert** method can be used. It accepts a c-string as
input and a delimiter, as **std::string**, and retruns a **tuple** of objects in input and a delimiter, as **std::string**, and retruns a **tuple** of objects in
the same way as **get_next** does it for the parser. A whole object can be returned the same way **get_next** does it for the parser. A whole object can be returned
too using the **convert_object** method, again in an identical way **get_object** too using the **convert_object** method, again in an identical way **get_object**
doest it for the parser. doest it for the parser.
```cpp ```cpp
@ -438,8 +438,9 @@ All special types and restrictions work on the converter too. Error handling is
also identical to error handling of the parser. also identical to error handling of the parser.
The converter has also the ability to just split the line, tho it does not The converter has also the ability to just split the line, tho it does not
change it, statically, hence the name of the library. It returns an **std::vector** change it (kinda statically), hence the name of the library.
of pairs of pointers, each **std::pair** representing a split segment of the string. It returns an **std::vector** of pairs of pointers, begin and end,
each **std::pair** representing a split segment (column) of the whole string.
The vector can then be used in a overloaded **convert** method. This allows the The vector can then be used in a overloaded **convert** method. This allows the
reuse of the same line without splitting it on every conversion. reuse of the same line without splitting it on every conversion.
```cpp ```cpp