TFormat< TChar >::Escape Struct Reference

Description:

template<typename TChar>
struct alib::strings::TFormat< TChar >::Escape

---

Implements a temporary object which is appended to instances of type AString .

Escapes non-printable characters in the given region, or reversely converts such escaped characters to their ASCII values.

The characters converted are '\\', '\r', '\n', '\t', '\a', '\b', '\v', '\f', '\e' and '"'.

If the new region length is needed to be known, it can be calculated as the sum of the old region length and the difference of the string's length before and after the operation.

Definition at line 233 of file format.hpp.

#include <format.hpp>

Public Field Index:
integer	length
lang::Switch	pSwitch
integer	startIdx

Public Method Index:
	Escape (lang::Switch escape=lang::Switch::On, integer regionStart=0, integer regionLength=MAX_LEN)

Field Details:

length

template<typename TChar >

integer length

The length of the region to convert.

Definition at line 244 of file format.hpp.

pSwitch

template<typename TChar >

lang::Switch pSwitch

The direction of conversion: Switch::On escapes ascii characters, while Switch::Off converts escaped strings to ascii codes.

Definition at line 238 of file format.hpp.

startIdx

template<typename TChar >

integer startIdx

The start of the region to convert.

Definition at line 241 of file format.hpp.

Constructor(s) / Destructor Details::

Escape()

template<typename TChar >

Escape ( lang::Switch escape = lang::Switch::On, integer regionStart = 0, integer regionLength = MAX_LEN )

inline

Constructor. Copies the parameters.

Parameters

escape	Switch::On escapes ascii characters (the default), Switch::Off converts escaped strings to ascii codes.
regionStart	The start of the region to convert.
regionLength	The length of the region to convert.

Definition at line 255 of file format.hpp.

---

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

• format.hpp