String :: capacity - Get the number of character units which can be stored in the allocated area.

The function returns the maximum number of character units (8 bit, 16 bit or 32 bit) that can be stored in the string without forcing a reallocation.

The sole purpose of this function is to provide a means of fine tuning odaba::String's memory usage. In general, you will rarely ever need to call this function. If you want to know how many character units are in the string, call lengthInUnits().