an.tsouchlos/const_fmt
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added limitations to README

Browse Source
This commit is contained in:
an.tsouchlos 2022-02-09 16:45:04 +00:00
parent 6597a3a360
commit c9e845b025
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -10,7 +10,7 @@ Meant for systems with very few resources, such as embedded systems.
During compile-time, the string to be formatted is preprocessed to the point, only the actual values to be formatted During compile-time, the string to be formatted is preprocessed to the point, only the actual values to be formatted
have to be written (If they are not available at compile time). have to be written (If they are not available at compile time).
For example `One number: {:08}; And another one: {:05.3}` is preprocessed into `One number: 000; And another one: 00.000`. For example `One number: {:03}; And another one: {:05.3}` is preprocessed into `One number: 000; And another one: 00.000`.
This is returned as a `std::array<char, N>`, where `N` is automatically evaluated. The only code executed at compile This is returned as a `std::array<char, N>`, where `N` is automatically evaluated. The only code executed at compile
time then formats the numbers and writes them into their place in the array. time then formats the numbers and writes them into their place in the array.
@ -36,4 +36,12 @@ $ cmake --build build/
4. Run the tests 4. Run the tests
```bash ```bash
$ ctest --test-dir build/ $ ctest --test-dir build/
``` ```
## Limitations
Only a relatively limited subset of the `fmtlib` syntax is recognized (for now anyway). In particular,
there is no support for positional arguments, alignment, chrono format specs and custom format specifications.
By nature of the library design, which forces compile-time preprocessing of the format string, no dynamic width or
dynamic precision can be implemented.