[#llvm-formatv_object_base]
= xref:llvm.adoc[llvm]::formatv_object_base
:relfileprefix: ../
:mrdocs:

Base class for formatv objects used by Twine.

== Synopsis

Declared in `<llvm/Support/FormatVariadic.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class formatv_object_base;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/formatv_object_base/format.adoc[`format`] 
| Write the formatted string to `S.`
| xref:llvm/formatv_object_base/sstr.adoc[`sstr`] 
| Convert the formatted result to a `SmallString` of capacity `N.`
| xref:llvm/formatv_object_base/str.adoc[`str`] 
| Convert the formatted result to a `std::string.`
| xref:llvm/formatv_object_base/2conversion-06.adoc[`operator SmallString<N>`] 
| Convert the formatted result to a `SmallString` of capacity `N.`
| xref:llvm/formatv_object_base/2conversion-04.adoc[`operator std::string`] 
| Convert the formatted result to a `std::string.`
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/formatv_object_base/parseFormatString.adoc[`parseFormatString`] 
| Parse and optionally validate a format string.
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/formatv_object_base/2constructor-08.adoc[`formatv_object_base`]         [.small]#[constructor]#
| Constructors
|===


== Protected Data Members

[cols="1,4"]
|===
| Name| Description
| xref:llvm/formatv_object_base/Adapters.adoc[`Adapters`] 
| Type‐erased functors that format each parameter.
| xref:llvm/formatv_object_base/Fmt.adoc[`Fmt`] 
| Format string containing replacement fields and literal text.
| xref:llvm/formatv_object_base/Validate.adoc[`Validate`] 
| When true, parse and validate the format string in assert‐enabled builds.
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:llvm/formatv_object.adoc[`formatv_object`] 
| Owning formatv result that stores parameters and type‐erased adapters.
|===


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