baltzo::ErrorCode Struct Reference

#include <baltzo_errorcode.h>

Public Types
enum	Enum { k_UNSUPPORTED_ID = 1 , k_OUT_OF_RANGE = 2 , BAETZO_UNSUPPORTED_ID = k_UNSUPPORTED_ID }

Static Public Member Functions
static bsl::ostream &	print (bsl::ostream &stream, ErrorCode::Enum value, int level=0, int spacesPerLevel=4)
static const char *	toAscii (ErrorCode::Enum value)

Detailed Description

This struct provides a namespace for enumerating the set of named error codes that may be returned by functions in the baltzo package that take a Zoneinfo string identifier as input. See Enum in the TYPES sub-section for details.

This class:

• supports a complete set of enumeration operations
  • except for bdex serialization
• is const thread-safe For terminology see bsldoc_glossary .

Member Enumeration Documentation

Enum

enum baltzo::ErrorCode::Enum

Enumerator
k_UNSUPPORTED_ID
k_OUT_OF_RANGE
BAETZO_UNSUPPORTED_ID

Member Function Documentation

print()

static bsl::ostream & baltzo::ErrorCode::print ( bsl::ostream &  stream, ErrorCode::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 ErrorCode::Enum value.

toAscii()

static const char * baltzo::ErrorCode::toAscii ( ErrorCode::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 << ErrorCode::toAscii(ErrorCode::k_UNSUPPORTED_ID);

will print the following on standard output:

UNSUPPORTED_ID

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:

• baltzo_errorcode.h