[#BloombergLP-bdlb-CharType]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlb.adoc[bdlb]::CharType
:relfileprefix: ../../
:mrdocs:

This `struct` provides a namespace for a suite of pure procedures operating on the fundamental type `char`.

== Synopsis

Declared in `<bdlb_chartype.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct CharType;
----

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlb/CharType/_04enum.adoc[`Unnamed enum`] 
| Constants for this component.
| xref:BloombergLP/bdlb/CharType/Category.adoc[`Category`] 
| Set of character categories supported by this component.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlb/CharType/isAll.adoc[`isAll`] 
| Return `true` if the specified `character` is in the `ALL` category (i.e., `[0‐377]`), and `false` otherwise. Note that this function always returns `true`, but is provide for completeness.
| xref:BloombergLP/bdlb/CharType/isAlnum.adoc[`isAlnum`] 
| Return `true` if the specified `character` is in the `ALNUM` category (i.e., `[0‐9A‐Za‐Z]`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isAlpha.adoc[`isAlpha`] 
| Return `true` if the specified `character` is in the `ALPHA` category (i.e., `[A‐Za‐z]`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isAlund.adoc[`isAlund`] 
| Return `true` if the specified `character` is in the `ALUND` category (i.e., `[ALPHA|]`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isAscii.adoc[`isAscii`] 
| Return `true` if the specified `character` is in the `ASCII` category (i.e., `[0‐177]`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isCategory.adoc[`isCategory`] 
| Return `true` if the specified `character` is in the specified `category`, and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isCntrl.adoc[`isCntrl`] 
| Return `true` if the specified `character` is in the `CNTRL` category (i.e., `[1‐37]` and `177`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isDigit.adoc[`isDigit`] 
| Return `true` if the specified `character` is in the `DIGIT` category (i.e., `[0‐9]`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isGraph.adoc[`isGraph`] 
| Return `true` if the specified `character` is in the `GRAPH` category (i.e., any printable character except `SPACE`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isIdent.adoc[`isIdent`] 
| Return `true` if the specified `character` is in the `IDENT` category (i.e., `[ALNUM|]`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isLower.adoc[`isLower`] 
| Return `true` if the specified `character` is in the `LOWER` category (i.e., `[a‐z]`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isNone.adoc[`isNone`] 
| Return `true` if the specified `character` is in the `NONE` category (i.e., `[]`), and `false` otherwise. Note that this function always returns `false`, but is provided for completeness.
| xref:BloombergLP/bdlb/CharType/isOdigit.adoc[`isOdigit`] 
| Return `true` if the specified `character` is in the `ODIGIT` category (i.e., `[0‐7]`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isPrint.adoc[`isPrint`] 
| Return `true` if the specified `character` is in the `PRINT` category (i.e., any printable character including `SPACE`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isPunct.adoc[`isPunct`] 
| Return `true` if the specified `character` is in the `PUNCT` category (i.e., any printable character other than `SPACE` or `ALNUM`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isSpace.adoc[`isSpace`] 
| Return `true` if the specified `character` is in the `SPACE` category (i.e., `[space|tab|CR|NL|VT|FF]`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isUpper.adoc[`isUpper`] 
| Return `true` if the specified `character` is in the `UPPER` category (i.e., `[A‐Z]`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/isXdigit.adoc[`isXdigit`] 
| Return `true` if the specified `character` is in the `XDIGIT` category (i.e., `[0‐9A‐Fa‐f]`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/numAll.adoc[`numAll`] 
| Return the number of characters in the category `ALL`. Note that the character string returned by the `stringAll` method is of length 255, but the terminating null is part of the set.
| xref:BloombergLP/bdlb/CharType/numAlnum.adoc[`numAlnum`] 
| Return the number of characters in the category `ALNUM` (i.e., `[0‐9A‐Za‐Z]`).
| xref:BloombergLP/bdlb/CharType/numAlpha.adoc[`numAlpha`] 
| Return the number of characters in the category `ALPHA` (i.e., `[A‐Za‐z]`).
| xref:BloombergLP/bdlb/CharType/numAlund.adoc[`numAlund`] 
| Return the number of characters in the category `ALUND` (i.e., `[ALPHA|]`).
| xref:BloombergLP/bdlb/CharType/numAscii.adoc[`numAscii`] 
| Return the number of characters in the category `ASCII` (i.e., `[0‐177]`).
| xref:BloombergLP/bdlb/CharType/numCategory.adoc[`numCategory`] 
| Return the number of characters in the specified `category`.
| xref:BloombergLP/bdlb/CharType/numCntrl.adoc[`numCntrl`] 
| Return the number of characters in the category `CNTRL` (i.e., `[1‐37]` and `177`).
| xref:BloombergLP/bdlb/CharType/numDigit.adoc[`numDigit`] 
| Return the number of characters in the category `DIGIT` (i.e., `[0‐9]`).
| xref:BloombergLP/bdlb/CharType/numGraph.adoc[`numGraph`] 
| Return the number of characters in the category `GRAPH` (i.e., any printable character except `SPACE`), and `false` otherwise.
| xref:BloombergLP/bdlb/CharType/numIdent.adoc[`numIdent`] 
| Return the number of characters in the category `IDENT` (i.e., `[ALNUM|]`).
| xref:BloombergLP/bdlb/CharType/numLower.adoc[`numLower`] 
| Return the number of characters in the category `LOWER` (i.e., `[a‐z]`).
| xref:BloombergLP/bdlb/CharType/numNone.adoc[`numNone`] 
| Return the number of characters in the category `NONE`. Note that the string returned by the `stringNone` method is empty.
| xref:BloombergLP/bdlb/CharType/numOdigit.adoc[`numOdigit`] 
| Return the number of characters in the category `ODIGIT` (i.e., `[0‐7]`).
| xref:BloombergLP/bdlb/CharType/numPrint.adoc[`numPrint`] 
| Return the number of characters in the category `PRINT` (i.e., any printable character including `SPACE`).
| xref:BloombergLP/bdlb/CharType/numPunct.adoc[`numPunct`] 
| Return the number of characters in the category `PUNCT` (i.e., any printable character other than `SPACE` or `ALNUM`).
| xref:BloombergLP/bdlb/CharType/numSpace.adoc[`numSpace`] 
| Return the number of characters in the category `SPACE` (i.e., `[space|tab|CR|NL|VT|FF]`).
| xref:BloombergLP/bdlb/CharType/numUpper.adoc[`numUpper`] 
| Return the number of characters in the category `UPPER` (i.e., `[A‐Z]`).
| xref:BloombergLP/bdlb/CharType/numXdigit.adoc[`numXdigit`] 
| Return the number of characters in the category `XDIGIT` (i.e., `[0‐9A‐Fa‐f]`).
| xref:BloombergLP/bdlb/CharType/stringAll.adoc[`stringAll`] 
| Return a null‐terminated string consisting of all characters in the category `ALL` (i.e., `[0‐377]`), ordered by increasing character codes. Note that this string, if printed, may appear to be of length 0 because the `NULL` character is part of the set and appears first.
| xref:BloombergLP/bdlb/CharType/stringAlnum.adoc[`stringAlnum`] 
| Return a null‐terminated string consisting of all characters in the category `ALNUM` (i.e., `[0‐9A‐Za‐Z]`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/stringAlpha.adoc[`stringAlpha`] 
| Return a null‐terminated string consisting of all characters in the category `ALPHA` (i.e., `[A‐Za‐z]`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/stringAlund.adoc[`stringAlund`] 
| Return a null‐terminated string consisting of all characters in the category `ALUND` (i.e., `[ALPHA|]`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/stringAscii.adoc[`stringAscii`] 
| Return a null‐terminated string consisting of all characters in the category `ASCII` (i.e., `[0‐177]`), ordered by increasing character codes. Note that this string, if printed, may appear to be of length 0 because the `NULL` character is part of the set and appears first.
| xref:BloombergLP/bdlb/CharType/stringCategory.adoc[`stringCategory`] 
| Return a null‐terminated string consisting of all characters in the specified `category`, ordered by increasing character codes. Note that for category values of `CNTRL`, `ASCII, and `ALL`, this string, if printed, may appear to be of length 0 because the `NULL` character is part of the set and appears first.
| xref:BloombergLP/bdlb/CharType/stringCntrl.adoc[`stringCntrl`] 
| Return a null‐terminated string consisting of all characters in the category `CNTRL` (i.e., `[0‐37]` and `177`), ordered by increasing character codes. Note that this string, if printed, may appear to be of length 0 because the `NULL` character is part of the set and appears first.
| xref:BloombergLP/bdlb/CharType/stringDigit.adoc[`stringDigit`] 
| Return a null‐terminated string consisting of all characters in the category `DIGIT` (i.e., `[0‐9]`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/stringGraph.adoc[`stringGraph`] 
| Return a null‐terminated string consisting of all characters in the category `GRAPH` (i.e., any printable character except `SPACE`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/stringIdent.adoc[`stringIdent`] 
| Return a null‐terminated string consisting of all characters in the category `IDENT` (i.e., `[ALNUM|]`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/stringLower.adoc[`stringLower`] 
| Return a null‐terminated string consisting of all characters in the category `LOWER` (i.e., `[a‐z]`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/stringNone.adoc[`stringNone`] 
| Return a null‐terminated string consisting of all characters in the category `NONE`. Note that this string is empty.
| xref:BloombergLP/bdlb/CharType/stringOdigit.adoc[`stringOdigit`] 
| Return a null‐terminated string consisting of all characters in the category `DIGIT` (i.e., `[0‐7]`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/stringPrint.adoc[`stringPrint`] 
| Return a null‐terminated string consisting of all characters in the category `PRINT` (i.e., any printable character including `SPACE`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/stringPunct.adoc[`stringPunct`] 
| Return a null‐terminated string consisting of all characters in the category `PUNCT` (i.e., any printable character other than `SPACE` or `ALNUM`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/stringSpace.adoc[`stringSpace`] 
| Return a null‐terminated string consisting of all characters in the category `SPACE` (i.e., `[space|tab|CR|NL|VT|FF]`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/stringUpper.adoc[`stringUpper`] 
| Return a null‐terminated string consisting of all characters in the category `UPPER` (i.e., `[A‐Z]`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/stringXdigit.adoc[`stringXdigit`] 
| Return a null‐terminated string consisting of all characters in the category `XDIGIT` (i.e., `[0‐9A‐Fa‐f]`), ordered by increasing character codes.
| xref:BloombergLP/bdlb/CharType/toAscii.adoc[`toAscii`] 
| Return a null‐terminated string representation of the specified character `category` enumerator that is identical to the enumerator name.
| xref:BloombergLP/bdlb/CharType/toLower.adoc[`toLower`] 
| Return the character in the `LOWER` category corresponding to the specified `input` character from the `UPPER` category or `input` itself if `input` is not in category `UPPER`.
| xref:BloombergLP/bdlb/CharType/toUpper.adoc[`toUpper`] 
| Return the character in the `UPPER` category corresponding to the specified `input` character from the `LOWER` category or `input` itself if `input` is not in category `LOWER`.
|===



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