bdlde::ByteOrder Struct Reference

#include <bdlde_byteorder.h>

List of all members.

Public Types
enum	Enum { e_LITTLE_ENDIAN, e_BIG_ENDIAN, e_NETWORK = e_BIG_ENDIAN, e_HOST = e_BIG_ENDIAN }
Static Public Member Functions
static bsl::ostream &	print (bsl::ostream &stream, Enum value, int level=0, int spacesPerLevel=4)
static const char *	toAscii (Enum value)

---

Detailed Description

This struct provides a namespace for enumerating the set of byte orders. See Enum in the TYPES sub-section for details.

This class:

• supports a complete set of enumeration operations

  • except for bdex serialization

For terminology see bsldoc_glossary.

See Component bdlde_byteorder

---

Member Enumeration Documentation

enum bdlde::ByteOrder::Enum

Enumerator:

e_LITTLE_ENDIAN	base enumeration
e_BIG_ENDIAN	base enumeration
e_NETWORK	Network byte order is always aliased to big-endian.
e_HOST	depending on the platform.

---

Member Function Documentation

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

static const char* bdlde::ByteOrder::toAscii

(

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 the name of its corresponding base enumeration with the "e_" prefix elided. For example:

          bsl::cout << ByteOrder::toAscii(ByteOrder::e_NETWORK);

will print the following on standard output:

          BIG_ENDIAN

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_byteorder.h