bslfmt_formatterbool

Detailed Description

Provide a formatter customization for bool type.

Outline

• Purpose
• Classes
• Canonical Header
• Description
  • Usage
    • Example: Formatting a bool

Purpose

Provide a formatter customization for bool type

Classes

• bsl::formatter<bool, t_CHAR>: formatter specialization for bool

Canonical Header

bsl_format.h

Description

This component provides partial specializations of bsl::formatter catering for bool type.

This header is not intended to be included directly. Please include <bsl_format.h> to be able to use the bsl::formatter for bool type.

Usage

In this section we show the intended use of this component.

Example: Formatting a bool

We do not expect most users of bsl::format to interact with this type directly and instead use bsl::format or bsl::vformat, so this example is necessarily unrealistic.

Suppose we want to test this formatter's ability to format a boolean with defined alignment and padding.

 bslfmt::MockParseContext<char> mpc("*<6s", 1);
 
 bsl::formatter<bool, char> f;
 mpc.advance_to(f.parse(mpc));
 
 bool value = false;
 
 bslfmt::MockFormatContext<char> mfc(value, 0, 0);
 
 mfc.advance_to(bsl::as_const(f).format(value, mfc));
 
 assert("false*" == mfc.finalString());