[#BloombergLP-bslfmt-FormatterString_GraphemeCluster]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::FormatterString_GraphemeCluster
:relfileprefix: ../../
:mrdocs:

[*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>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class FormatterString_GraphemeCluster;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/2constructor.adoc[`FormatterString_GraphemeCluster`]         [.small]#[constructor]#
| Create an uninitialized cluster object (that is not valid).
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/extract.adoc[`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`.
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/firstCodePointValue.adoc[`firstCodePointValue`] 
| Return the value of the first code point in this cluster.
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/firstCodePointWidth.adoc[`firstCodePointWidth`] 
| Return the width of the first code point in this cluster.
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/isValid.adoc[`isValid`] 
| Return `true` if this object was successfully extracted and contains valid code point data, and `false` otherwise.
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/numCodePoints.adoc[`numCodePoints`] 
| Return the number of code points this cluster contains.
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/numSourceBytes.adoc[`numSourceBytes`] 
| Return the number of bytes occupied by this cluster.
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/reset.adoc[`reset`] 
| Reset this object to an uninitialized state.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#