[#util-ConstevalFormatString]
= xref:util.adoc[util]::ConstevalFormatString
:relfileprefix: ../
:mrdocs:

A wrapper for a compile‐time partially validated format string

== Synopsis

Declared in `<util/string.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<unsigned int num_params>
struct ConstevalFormatString;
----

== Description

This struct can be used to enforce partial compile‐time validation of format strings, to reduce the likelihood of tinyformat throwing exceptions at run‐time. Validation is partial to try and prevent the most common errors while avoiding re‐implementing the entire parsing logic.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:util/ConstevalFormatString/2constructor.adoc[`ConstevalFormatString`]         [.small]#[constructor]#
| Wrap and partially validate a format string at compile time.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:util/ConstevalFormatString/fmt.adoc[`fmt`] 
| The wrapped format string.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#