LibraryLink Utilities  3.0.1
Modern C++ wrapper over LibraryLink and WSTP
LLU::WS::EncodingConfig Namespace Reference

Contains configuration parameters that paclet developers may modify. More...

Detailed Description

Contains configuration parameters that paclet developers may modify.

Definitions of configuration parameters, see header file for detailed description.

Variables

long substituteCodeForByteEncoding = defaultSubstituteCode
 Global configuration parameter defining a substitute character required in WSGetByteString. More...
 
bool useFastUTF8 = true
 Global configuration parameter specifying whether to use a faster version of sending UTF8 strings. More...
 
constexpr long defaultSubstituteCode = 26
 Default substitute code is 26, which is an ascii character called "Substitute". More...
 

Variable Documentation

◆ defaultSubstituteCode

constexpr long LLU::WS::EncodingConfig::defaultSubstituteCode = 26
constexpr

Default substitute code is 26, which is an ascii character called "Substitute".

◆ substituteCodeForByteEncoding

long LLU::WS::EncodingConfig::substituteCodeForByteEncoding = defaultSubstituteCode

Global configuration parameter defining a substitute character required in WSGetByteString.

The default value is 26

◆ useFastUTF8

bool LLU::WS::EncodingConfig::useFastUTF8 = true

Global configuration parameter specifying whether to use a faster version of sending UTF8 strings.

It means that if a string only have ASCII characters then much faster WSPutByteString is used. The time of checking if the string only has ASCII characters is negligible compared to the time taken by WSPut*String, so this parameter is by default set to true.