ALib C++ Library
Library Version: 2412 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
T_ZTCharArray< TString, TChar, TEnableIf > Struct Template Reference

Description:

template<typename TString, typename TChar, typename TEnableIf = void>
struct alib::characters::T_ZTCharArray< TString, TChar, TEnableIf >

This type traits struct is in all aspects equivalent to T_CharArray, only that this struct provides traits on zero-terminated character arrays, while T_CharArray is about non-zero-terminated arrays.

Please, therefore consult the documentation of type T_CharArray.

See also
For detailed information, see chapter 4. Character Arrays of the Programmer's Manual of module ALib Characters.
Template Parameters
TStringThe type for which specializations of this struct provide array type traits.
TCharThe character type of the character array that specializations provide type traits for.
TEnableIfOptional TMP parameter to allow templated and/or selective specializations.

Definition at line 335 of file chartraits.hpp.

#include <chartraits.hpp>

Public Static Method Index:

static const TChar * Buffer (const TString &src)
 
static TString Construct (const TChar *array, integer length)
 
static integer Length (const TString &src)
 

Method Details:

◆ Buffer()

template<typename TString , typename TChar , typename TEnableIf = void>
static const TChar * Buffer ( const TString & src)
static

Same as corresponding method Buffer of sibling struct T_CharArray.

Parameters
srcThe source object of external type TString.
Returns
Specializations have to return a pointer to the start of the zero-terminated character array represented by the given object src of type TString.

◆ Construct()

template<typename TString , typename TChar , typename TEnableIf = void>
static TString Construct ( const TChar * array,
integer length )
static

Same as corresponding method Construct of sibling struct T_CharArray.

Parameters
arrayThe external zero-terminated array to be used to create the return value.
lengthThe length of the external array.
Returns
A new instance (value) of type TString.

◆ Length()

template<typename TString , typename TChar , typename TEnableIf = void>
static integer Length ( const TString & src)
static

Same as corresponding method Length of sibling struct T_CharArray.

Parameters
srcThe source object of external type TString.
Returns
Specializations have to return the length of the character array represented by the given object src of type TString.

The documentation for this struct was generated from the following file: