alib::format::FFormat Struct Reference

Description:

This struct declares the signature of the box-function FFormat. It can be implemented to write the contents of a boxed type the given AString instance, in accordance with a custom format specification.

See also

For more information about this class see chapter 3. Formatting Custom Types of the Programmer's Manual of module ALib Format.

Definition at line 19 of file formatter.inl.

Public Type Index:
using	Signature

Type Definition Details:

Signature

using alib::format::FFormat::Signature

Initial value:

 void (*) ( const Box& self, const String& formatSpec, NumberFormat& nf,
                                 AString& target )

Signature of the invokable function.
Implementations write the content of box to the given AString object target in accordance to the type-specific format specification formatSpec.

Parameters

self	The box that the function was invoked on.
formatSpec	The specification of the format (type specific). If empty, a default specification string might have to be chosen.
nf	A copy of the number format of the formatter (allowed to be modified).
target	The AString object receiving the formatted string.

Definition at line 30 of file formatter.inl.

---

The documentation for this struct was generated from the following file:

• formatter.inl