[#BloombergLP-bslfmt-FormatterString_GraphemeCluster]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::FormatterString&lowbar;GraphemeCluster
:relfileprefix: ../../
:mrdocs:

&lsqb;*PRIVATE*&rsqb;This private implementation `class` characterizes a grapheme cluster represented by a set of integral values&period; This class is private to this component and should not be used by clients&period;

== Synopsis

Declared in `&lt;bslfmt&lowbar;formatterstring&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class FormatterString&lowbar;GraphemeCluster;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/2constructor.adoc[`FormatterString&lowbar;GraphemeCluster`]         [.small]#[constructor]#
| Create an uninitialized cluster object (that is not valid)&period;
| 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`&period; Behavior is undefined if the input bytes are not in the specified encoding&period; Unicode Byte Order Markers are not supported and behavior is undefined if the input data contains an embedded BOM&period; Endianness is assumed to be that of the type pointed to by `bytes`&period;
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/firstCodePointValue.adoc[`firstCodePointValue`] 
| Return the value of the first code point in this cluster&period;
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/firstCodePointWidth.adoc[`firstCodePointWidth`] 
| Return the width of the first code point in this cluster&period;
| 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&period;
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/numCodePoints.adoc[`numCodePoints`] 
| Return the number of code points this cluster contains&period;
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/numSourceBytes.adoc[`numSourceBytes`] 
| Return the number of bytes occupied by this cluster&period;
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster/reset.adoc[`reset`] 
| Reset this object to an uninitialized state&period;
|===



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