Data formatting

A standard mechanism is provided for encoding and decoding text in commonly-used text formats using a Format::Formatter class implementation.

namespace Format

Typedefs

using Options = BitSet<uint8_t, Option, 5>

Enums

enum class Option

Values:

enumerator unicode

enumerator utf8: Convert extended ASCII to UTF8.

enumerator doublequote

enumerator singlequote

enumerator backslash

Functions

unsigned escapeControls(String &value, Options options)

Escape standard control codes such as \n (below ASCII 0x20)

Parameters:

value – String to be modified
options –

Return values:

unsigned – Number of control characters found and replaced

Variables

Html html

Json json

Standard standard

Xml xml

class Formatter

#include <Formatter.h>

Virtual class to perform format-specific String adjustments.

Subclassed by Format::Standard

Public Functions

virtual void escape(String &value) const = 0: Perform any necessary text escaping so output is valid.

virtual void quote(String &value) const = 0: Convert a value into quoted string.

virtual void unQuote(String &value) const = 0: Remove any quotes from a value.

virtual MimeType mimeType() const = 0: Corresponding MIME type for this format.

Note

New types must be added to WebConstants.h

class Html : public Format::Standard 

#include <Html.h>

Public Functions

virtual void escape(String &value) const override: Perform any necessary text escaping so output is valid.

inline virtual MimeType mimeType() const override: Corresponding MIME type for this format.

Note

New types must be added to WebConstants.h

class Json : public Format::Standard 

#include <Json.h>

Public Functions

virtual void escape(String &value) const override: Perform any necessary text escaping so output is valid.

virtual void quote(String &value) const override: Convert a value into quoted string.

inline virtual MimeType mimeType() const override: Corresponding MIME type for this format.

Note

New types must be added to WebConstants.h

class Standard : public Format::Formatter 

#include <Standard.h>

Subclassed by Format::Html, Format::Json, Format::Xml

Public Functions

inline virtual void escape(String&) const override: Perform any necessary text escaping so output is valid.

virtual void quote(String &value) const override: Convert a value into quoted string.

virtual void unQuote(String &value) const override: Remove any quotes from a value.

inline virtual MimeType mimeType() const override: Corresponding MIME type for this format.

Note

New types must be added to WebConstants.h

class Xml : public Format::Standard 

#include <Xml.h>

Public Functions

virtual void escape(String &value) const override: Perform any necessary text escaping so output is valid.

inline virtual MimeType mimeType() const override: Corresponding MIME type for this format.

Note

New types must be added to WebConstants.h