bdlde::CharConvertStatus Struct Reference

#include <bdlde_charconvertstatus.h>

List of all members.

Public Types
enum	Enum {   k_INVALID_INPUT_BIT = 0x1, k_OUT_OF_SPACE_BIT = 0x2, BDEDE_INVALID_CHARS_BIT = k_INVALID_INPUT_BIT, BDEDE_OUT_OF_SPACE_BIT = k_OUT_OF_SPACE_BIT,   k_INVALID_CHARS_BIT = k_INVALID_INPUT_BIT }
Static Public Member Functions
static bsl::ostream &	print (bsl::ostream &stream, CharConvertStatus::Enum value, int level=0, int spacesPerLevel=4)
static const char *	toAscii (CharConvertStatus::Enum value)

---

Detailed Description

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.

This class:

• supports a complete set of enumeration operations

  • except for bdex serialization

• is const thread-safe

For terminology see bsldoc_glossary.

See Component bdlde_charconvertstatus

---

Member Enumeration Documentation

enum bdlde::CharConvertStatus::Enum

Enumerator:

k_INVALID_INPUT_BIT	Invalid code points or sequences of bytes or words were encountered in the input.
k_OUT_OF_SPACE_BIT	The space provided for the output was insufficient for the translation.
BDEDE_INVALID_CHARS_BIT
BDEDE_OUT_OF_SPACE_BIT
k_INVALID_CHARS_BIT

---

Member Function Documentation

static bsl::ostream& bdlde::CharConvertStatus::print	(	bsl::ostream &	stream,
		CharConvertStatus::Enum	value,
		int	level = 0,
		int	spacesPerLevel = 4
	)			[static]

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.

static const char* bdlde::CharConvertStatus::toAscii

(

CharConvertStatus::Enum

value

)

[static]

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.

---

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

• bdlde_charconvertstatus.h