Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the develop branch, built from commit 498951f35c.

format_context

(EXPERIMENTAL) Format context for incremental SQL formatting.

Synopsis

Defined in header <boost/mysql/format_sql.hpp>

using format_context = basic_format_context< std::string >;

Member Functions

Name	Description
add_error	Adds an error to the current error state.
append_raw	Adds raw SQL to the output string.
append_value	Formats a value and adds it to the output string.
basic_format_context	Constructor. — Move constructor.
error_state	Retrieves the current error state.
format_opts	Retrieves the format options.
get	Retrieves the result of the formatting operation.
operator=	Move assignment.

The primary interface for incremental SQL formatting. Contrary to format_context_base, this type is aware of the output string's actual type. basic_format_context owns an instance of OutputString. Format operations will append characters to such string.

Objects of this type are single-use: once the result has been retrieved using get, they cannot be re-used. This is a move-only type.

Description

Convenience type alias for basic_format_context's most common case.