This struct provides a namespace for enumerating the set of mask codes that can be used to interpret int return values from translation functions in bdede.

Synopsis

Declared in <bdlde_charconvertstatus.h>

struct CharConvertStatus;

Description

This class: * supports a complete set of enumeration operations

  • except for bdex serialization * is const thread‐safe For terminology see bsldoc_glossary.

Enums

Name

Description

Enum

Bit‐masks returned by character‐conversion functions to report conversion issues.

Static Member Functions

Name

Description

print

Write the string representation of the specified enumeration value to the specified output stream, and return a reference to stream. Optionally specify an initial indentation level, whose absolute value is incremented recursively for nested objects. If level is specified, optionally specify spacesPerLevel, whose absolute value indicates the number of spaces per indentation level for this and all of its nested objects. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by level). See toAscii for what constitutes the string representation of a CharConvertStatus::Enum value.

toAscii

Return the non‐modifiable string representation corresponding to the specified enumeration value, if it exists, and a unique (error) string otherwise. The string representation of value matches its corresponding enumerator name with the "k_" prefix elided. For example: ` bsl::cout << CharConvertStatus::toAscii( CharConvertStatus::k_OUT_OF_SPACE_BIT); ` will print the following on standard output: ` OUT_OF_SPACE_BIT ` Note that specifying a value that does not match any of the enumerators will result in a string representation that is distinct from any of those corresponding to the enumerators, but is otherwise unspecified.

Created with MrDocs