ALib C++ Library
Library Version: 2312 R0
Documentation generated by doxygen
Public Static Methods | List of all members
T_ZTCharArray< TString, TChar, TEnableIf > Struct Template Reference

#include <characters.hpp>

Class Description

template<typename TString, typename TChar, typename TEnableIf = void>
struct aworx::lib::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 376 of file characters.hpp.

Public Static Methods

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

Member Function Documentation

◆ Buffer()

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
Specializatins have to return a pointer to the start of the zero-terminated character array represented by the given object src of type TString.

◆ Construct()

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()

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
Specializatins 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: