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

change README

Browse Source
This commit is contained in:
ado 2022-03-28 20:02:15 +02:00
parent 642750dc53
commit 4f8fcae350
1 changed files with 54 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
README.md
View File

@ -83,6 +83,60 @@ The library supports [CMake](#Cmake) and [meson](#Meson) build systems
# Usage # Usage
## Headers
The parser can be told to use only certain columns by parsing the header. This is done using the **use_fields** method. It accepts any number of string-like arguments or even an **std::vector<std::string>** with the field names. If any of the fields are not found within the header or if any fields are defined multiple times it will result in an error.
```shell
$ cat students_with_header.csv
Name,Age,Grade
James Bailey,65,2.5
Brian S. Wolfe,40,1.9
Bill (Heath) Gates,65,3.3
```
```cpp
// ...
ss::parser p{"students.csv", ","};
p.use_fields("Name", "Grade");
for(const auto& [name, grade] : p.iterate<std::string, float>()) {
std::cout << name << ' ' << grade << std::endl;
}
// ...
```
```shell
$ ./a.out
James Bailey 2.5
Brian S. Wolfe 1.9
Bill (Heath) Gates 3.3
```
The header can be ignored using the **ss::ignore_header** [setup](#Setup) option or by calling the **ignore_next** metod after the parser has been constructed.
```cpp
ss::parser<ss::ignore_header> p{file_name};
```
The fields with which the parser works with can be modified at any given time. The paser can also check if a field is present within the header by using the **has_field** method.
```cpp
// ...
ss::parser p{"students.csv", ","};
p.use_fields("Name", "Grade");
const auto& [name, grade] = p.get_next<std::string, float>();
std::cout << name << ' ' << grade << std::endl;
if (p.field_exists("Age")) {
p.use_fields("Grade", "Name", "Age");
for (const auto& [grade, name, age] :
p.iterate<float, std::string, int>()) {
std::cout << grade << ' ' << name << ' ' << age << std::endl;
}
}
// ...
```
```shell
$ ./a.out
James Bailey 2.5
1.9 Brian S. Wolfe 40
3.3 Bill (Heath) Gates 65
```
## Conversions ## Conversions
An alternate loop to the example above would look like: An alternate loop to the example above would look like:
```cpp ```cpp
@ -149,60 +203,6 @@ auto s = p.get_next<student>();
This works with the iteration loop too. This works with the iteration loop too.
*Note, the order in which the members of the tied method are returned must match the order of the elements in the csv*. *Note, the order in which the members of the tied method are returned must match the order of the elements in the csv*.
## Headers
The parser can be told to use only certain columns by parsing the header. This is done using the **use_fields** method. It accepts any number of string-like arguments or even an **std::vector<std::string>** with the field names. If any of the fields are not found within the header or if any fields are defined multiple times it will result in an error.
```shell
$ cat students_with_header.csv
Name,Age,Grade
James Bailey,65,2.5
Brian S. Wolfe,40,1.9
Bill (Heath) Gates,65,3.3
```
```cpp
// ...
ss::parser p{"students.csv", ","};
p.use_fields("Name", "Grade");
for(const auto& [name, grade] : p.iterate<std::string, float>()) {
std::cout << name << ' ' << grade << std::endl;
}
// ...
```
```shell
$ ./a.out
James Bailey 2.5
Brian S. Wolfe 1.9
Bill (Heath) Gates 3.3
```
The header can be ignored using the **ss::ignore_header** [setup](#Setup) option or by calling the **ignore_next** metod after the parser has been constructed.
```cpp
ss::parser<ss::ignore_header> p{file_name};
```
The fields with which the parser works with can be modified at any given time. The paser can also check if a field is present within the header by using the **has_field** method.
```cpp
// ...
ss::parser p{"students.csv", ","};
p.use_fields("Name", "Grade");
const auto& [name, grade] = p.get_next<std::string, float>();
std::cout << name << ' ' << grade << std::endl;
if (p.field_exists("Age")) {
p.use_fields("Grade", "Name", "Age");
for (const auto& [grade, name, age] :
p.iterate<float, std::string, int>()) {
std::cout << grade << ' ' << name << ' ' << age << std::endl;
}
}
// ...
```
```shell
$ ./a.out
James Bailey 2.5
1.9 Brian S. Wolfe 40
3.3 Bill (Heath) Gates 65
```
## Setup ## Setup
By default, many of the features supported by the parser are disabled. They can be enabled within the template parameters of the parser. For example, to enable quoting and escaping the parser would look like: By default, many of the features supported by the parser are disabled. They can be enabled within the template parameters of the parser. For example, to enable quoting and escaping the parser would look like:
```cpp ```cpp