bslfmt_formattercharacter

Detailed Description

Provide a formatter customization for character types.

Outline

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

Purpose

Provide a formatter customization for character types

Classes

• formatter<char, wchar_t> : specialization for char and wchar_t
• formatter<char, char> : specialization for chars
• formatter<wchar_t, wchar_t> : specialization for wchar_ts

Canonical Header

bsl_format.h

Description

This component provides partial specializations of bsl::formatter catering for character types.

This header is not intended to be included directly. Please include <bsl_format.h> to be able to use specializations of the bsl::formatter for character types.

Usage

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

Example: Formatting a character

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 present a character with defined alignment and padding.

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