bslfmt_formatterintegral

Detailed Description

Provide a formatter customization for integer types.

Outline

• Purpose
• Classes
• Canonical Header
• Description
  • Usage
    • Example: Formatting an integer

Purpose

Provide a formatter customization for integer types

Classes

• bsl::formatter<short, t_CHAR>: formatter specialization for short
• bsl::formatter<unsigned short, t_CHAR>: specialization for unsigned short
• bsl::formatter<int, t_CHAR>: formatter specialization for int
• bsl::formatter<unsigned, t_CHAR>: formatter specialization for unsigned
• bsl::formatter<long, t_CHAR>: formatter specialization for long
• bsl::formatter<unsigned long, t_CHAR>: specialization for unsigned long
• bsl::formatter<long long, t_CHAR>: formatter specialization for long long
• bsl::formatter<unsigned long long, t_CHAR>: for unsigned long long

Canonical Header

bsl_format.h

Description

This component provides partial specializations of bsl::formatter catering for integer 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 integral types.

Usage

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

Example: Formatting an integer

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 an integer with defined alignment and padding.

 bslfmt::MockParseContext<char> mpc("*<5x", 1);
 
 bsl::formatter<int, char> f;
 mpc.advance_to(f.parse(mpc));
 
 int value = 42;
 
 bslfmt::MockFormatContext<char> mfc(value, 0, 0);
 
 mfc.advance_to(bsl::as_const(f).format(value, mfc));
 
 assert("2a***" == mfc.finalString());