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

Characterizes a Unicode code point as a set of integral attributes.

== Synopsis

Declared in `<bslfmt_unicodecodepoint.h>`

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

== Description

This simply constrained (value‐semantic) attribute class characterizes a Unicode code point represented by a set of integral values. This class is private to this package and should not be used by clients.

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/UnicodeCodePoint/UtfEncoding.adoc[`UtfEncoding`] 
| UTF encodings supported by `UnicodeCodePoint`.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/UnicodeCodePoint/2constructor.adoc[`UnicodeCodePoint`]         [.small]#[constructor]#
| Create an uninitialized Unicode code point object
| xref:BloombergLP/bslfmt/UnicodeCodePoint/codePointValue.adoc[`codePointValue`] 
| Return the value of this code point.
| xref:BloombergLP/bslfmt/UnicodeCodePoint/codePointWidth.adoc[`codePointWidth`] 
| Return the width of this code point.
| xref:BloombergLP/bslfmt/UnicodeCodePoint/extract.adoc[`extract`] 
| Extract a code point into this object from an encoded byte stream.
| xref:BloombergLP/bslfmt/UnicodeCodePoint/isValid.adoc[`isValid`] 
| Return `true` if this object was successfully extracted and contains valid code point data, and `false` otherwise.
| xref:BloombergLP/bslfmt/UnicodeCodePoint/numSourceBytes.adoc[`numSourceBytes`] 
| Return how many source bytes encode this code point.
| xref:BloombergLP/bslfmt/UnicodeCodePoint/reset.adoc[`reset`] 
| Reset this object to the default state.
|===



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