[#BloombergLP-bslfmt-basic_format_string]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::basic_format_string
:relfileprefix: ../../
:mrdocs:

Type that wraps a `basic_string_view` for use by formatting function. The constructor performs additional compile‐time checks of the format string provided (not yet implemented).

== Synopsis

Declared in `<bslfmt_format_string.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_CHAR,
    class... t_ARGS>
class basic_format_string;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/basic_format_string/2constructor.adoc[`basic_format_string`]         [.small]#[constructor]#
| Create an instance of this type from the specified `str`. This function only takes part in overload resolution if `str` is convertible to a `basic_string_view`. Construction is ill‐formed if `str` is not a compile‐time constant.
| xref:BloombergLP/bslfmt/basic_format_string/get.adoc[`get`] 
| Return the wrapped `basic_string_view` contained by this instance.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslfmt/Format_String_TestUpdater.adoc[BloombergLP::bslfmt::Format_String_TestUpdater]`
| This is a component‐private type which enables test drivers to work around the compile‐time restrictions in `basic_format_string` construction.
|===


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