bblanchon/ArduinoJson
1
0
Fork 1
mirror of https://github.com/bblanchon/ArduinoJson.git synced 2025-09-25 22:40:56 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated API Reference (markdown)

Benoît Blanchon
2017-01-05 21:36:19 +01:00
parent 21b05dac63
commit fbfa61eadf
1 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
API-Reference.md

@@ -722,9 +722,19 @@ Therefore, it's recommended to have a JSON input in a `char[]` or a `char*`.
##### Signatures ##### Signatures
```c++ ```c++
JsonArray& parseArray(char* json, uint8_t nestingLimit=10); // <- recommended // The first overload, which accepts a modifiable array of chars, is the most efficient
// since it allows the zero-copy feature.
JsonArray& parseArray(char* json, uint8_t nestingLimit=10);
// The three following overloads, which accept read-only strings, require a bigger JsonBuffer
// because parts of the JSON input has to be copied.
JsonArray& parseArray(const char* json, uint8_t nestingLimit=10); JsonArray& parseArray(const char* json, uint8_t nestingLimit=10);
JsonArray& parseArray(const String& json, uint8_t nestingLimit=10); JsonArray& parseArray(const String& json, uint8_t nestingLimit=10);
JsonArray& parseArray(const std::string& json, uint8_t nestingLimit=10);
// The two last overloads, which accept input streams, make copy of the input too.
JsonArray& parseArray(Stream& json, uint8_t nestingLimit=10);
JsonArray& parseArray(std::istream& json, uint8_t nestingLimit=10);
``` ```
##### Arguments ##### Arguments
@@ -763,9 +773,19 @@ Therefore, it's recommended to have a JSON input in a `char[]` or a `char*`.
##### Signatures ##### Signatures
```c++ ```c++
JsonObject& parseObject(char* json, uint8_t nestingLimit=10); // <- recommended // The first overload, which accepts a modifiable array of chars, is the most efficient
// since it allows the zero-copy feature.
JsonObject& parseObject(char* json, uint8_t nestingLimit=10);
// The three following overloads, which accept read-only strings, require a bigger JsonBuffer
// because parts of the JSON input has to be copied.
JsonObject& parseObject(const char* json, uint8_t nestingLimit=10); JsonObject& parseObject(const char* json, uint8_t nestingLimit=10);
JsonObject& parseObject(const String& json, uint8_t nestingLimit=10); JsonObject& parseObject(const String& json, uint8_t nestingLimit=10);
JsonObject& parseObject(const std::string& json, uint8_t nestingLimit=10);
// The two last overloads, which accept input streams, make copy of the input too.
JsonObject& parseObject(Stream& json, uint8_t nestingLimit=10);
JsonObject& parseObject(std::istream& json, uint8_t nestingLimit=10);
``` ```
##### Arguments ##### Arguments