Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: MaximInterface
document.h File Reference
Go to the source code of this file.
Data Structures | |
| struct | GenericMember< Encoding, Allocator > |
| Name-value pair in a JSON object value. More... | |
| class | GenericMemberIterator< Const, Encoding, Allocator > |
| (Constant) member iterator for a JSON object value More... | |
| struct | GenericMemberIterator< false, Encoding, Allocator > |
| non-const GenericMemberIterator More... | |
| struct | GenericMemberIterator< true, Encoding, Allocator > |
| const GenericMemberIterator More... | |
| struct | GenericStringRef< CharType > |
| Reference to a constant string (not taking a copy) More... | |
| class | GenericValue< Encoding, Allocator > |
| Represents a JSON value. Use Value for UTF8 encoding and default allocator. More... | |
| class | GenericDocument< Encoding, Allocator, StackAllocator > |
| A document for parsing JSON text as DOM. More... | |
| class | GenericArray< Const, ValueT > |
| Helper class for accessing Value of array type. More... | |
| class | GenericObject< Const, ValueT > |
| Helper class for accessing Value of object type. More... | |
Typedefs | |
| typedef GenericValue< UTF8<> > | Value |
| GenericValue with UTF8 encoding. | |
| typedef GenericDocument< UTF8<> > | Document |
| GenericDocument with UTF8 encoding. | |
Functions | |
| template<typename CharType > | |
| GenericStringRef< CharType > | StringRef (const CharType *str) |
| Mark a character pointer as constant string. | |
| template<typename CharType > | |
| GenericStringRef< CharType > | StringRef (const CharType *str, size_t length) |
| Mark a character pointer as constant string. | |
| template<typename CharType > | |
| GenericStringRef< CharType > | StringRef (const std::basic_string< CharType > &str) |
| Mark a string object as constant string. | |
Detailed Description
Definition in file document.h.
Typedef Documentation
| typedef GenericDocument<UTF8<> > Document |
GenericDocument with UTF8 encoding.
Definition at line 2402 of file document.h.
| typedef GenericValue<UTF8<> > Value |
GenericValue with UTF8 encoding.
Definition at line 2010 of file document.h.
Function Documentation
| GenericStringRef< CharType > StringRef | ( | const std::basic_string< CharType > & | str ) |
Mark a string object as constant string.
Mark a string object (e.g. std::string) as a "string literal". This function can be used to avoid copying a string to be referenced as a value in a JSON GenericValue object, if the string's lifetime is known to be valid long enough.
- Template Parameters:
-
CharType character type of the string
- Parameters:
-
str Constant string, lifetime assumed to be longer than the use of the string in e.g. a GenericValue
- Returns:
- GenericStringRef string reference object
- Note:
- Requires the definition of the preprocessor symbol RAPIDJSON_HAS_STDSTRING.
Definition at line 384 of file document.h.
| GenericStringRef< CharType > StringRef | ( | const CharType * | str, |
| size_t | length | ||
| ) |
Mark a character pointer as constant string.
Mark a plain character pointer as a "string literal". This function can be used to avoid copying a character string to be referenced as a value in a JSON GenericValue object, if the string's lifetime is known to be valid long enough.
This version has better performance with supplied length, and also supports string containing null characters.
- Template Parameters:
-
CharType character type of the string
- Parameters:
-
str Constant string, lifetime assumed to be longer than the use of the string in e.g. a GenericValue length The length of source string.
- Returns:
- GenericStringRef string reference object
Definition at line 366 of file document.h.
| GenericStringRef< CharType > StringRef | ( | const CharType * | str ) |
Mark a character pointer as constant string.
Mark a plain character pointer as a "string literal". This function can be used to avoid copying a character string to be referenced as a value in a JSON GenericValue object, if the string's lifetime is known to be valid long enough.
- Template Parameters:
-
CharType Character type of the string
- Parameters:
-
str Constant string, lifetime assumed to be longer than the use of the string in e.g. a GenericValue
- Returns:
- GenericStringRef string reference object
- See also:
- GenericValue::GenericValue(StringRefType), GenericValue::operator=(StringRefType), GenericValue::SetString(StringRefType), GenericValue::PushBack(StringRefType, Allocator&), GenericValue::AddMember
Definition at line 346 of file document.h.
Generated on Tue Jul 12 2022 12:06:50 by
1.7.2