[*PRIVATE*]This private implementation class characterizes a grapheme cluster represented by a set of integral values. This class is private to this component and should not be used by clients.

Synopsis

Declared in <bslfmt_formatterstring.h>

class FormatterString_GraphemeCluster;

Member Functions

Name

Description

FormatterString_GraphemeCluster [constructor]

Create an uninitialized cluster object (that is not valid).

extract

Extract a grapheme cluster from no more than the specified maxBytes of the byte stream at the specified bytes location in the specified encoding. Behavior is undefined if the input bytes are not in the specified encoding. Unicode Byte Order Markers are not supported and behavior is undefined if the input data contains an embedded BOM. Endianness is assumed to be that of the type pointed to by bytes.

firstCodePointValue

Return the value of the first code point in this cluster.

firstCodePointWidth

Return the width of the first code point in this cluster.

isValid

Return true if this object was successfully extracted and contains valid code point data, and false otherwise.

numCodePoints

Return the number of code points this cluster contains.

numSourceBytes

Return the number of bytes occupied by this cluster.

reset

Reset this object to an uninitialized state.

Created with MrDocs