Skip to content

Commit 052bf74

Browse files
authored
Added list of supported format argument types
1 parent af4051e commit 052bf74

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,21 @@ BM_binary_log_random_real<double> 12.7 ns 12
276276
- Note that switching to `uint16_t` here means that every log call _might_ store an extra byte to be able to refer to an entry in the index table - an extra byte per call could be an extra 1GB over billion log calls.
277277
* The [unit tests](https://github.com/p-ranav/binary_log/blob/master/test/source/test_packer.cpp) assume little endian for multi-byte data, e.g., int, float etc.
278278

279+
## Supported Format Argument Types
280+
281+
`binary_log` supports a limited number of types of format arguments. They are:
282+
283+
```
284+
bool,
285+
char,
286+
uint8_t, uint16_t, uint32_t, uint64_t
287+
int8_t, int16_t, int32_t, int64_t,
288+
float, double,
289+
const char*,
290+
std::string,
291+
std::string_view
292+
```
293+
279294
# Building and installing
280295

281296
See the [BUILDING](BUILDING.md) document.

0 commit comments

Comments
 (0)