ArduinoJson.h
Go to the documentation of this file.
15 * - Serialization/de-serialization functions with additional FlashString and stream pointer support:
32 * `json["key"].as<const char*>()` will return nullptr (same as ArduinoJson V5 `asString()` method)
96 template <typename TSource, typename TDest> bool getValueChanged(const TSource& source, TDest& dest)
132 template <typename TSource> size_t measure(const TSource& source, SerializationFormat format = JSON_FORMAT_DEFAULT)
160 size_t serialize(const TSource& source, TDestination& destination, SerializationFormat format = JSON_FORMAT_DEFAULT)
190 serialize(const TSource& source, TPrint* destination, SerializationFormat format = JSON_FORMAT_DEFAULT)
226 size_t serialize(const TSource& source, CString& output, SerializationFormat format = JSON_FORMAT_DEFAULT)
242 template <typename TSource> String serialize(const TSource& source, SerializationFormat format = JSON_FORMAT_DEFAULT)
257 bool saveToFile(const TSource& source, const String& filename, SerializationFormat format = JSON_FORMAT_DEFAULT)
272 bool deserializeInternal(JsonDocument& doc, TInput& input, SerializationFormat format = JSON_FORMAT_DEFAULT)
309 bool deserialize(JsonDocument& doc, TInput& input, SerializationFormat format = JSON_FORMAT_DEFAULT)
348 deserialize(JsonDocument& doc, TStream* input, SerializationFormat format = JSON_FORMAT_DEFAULT)
370 bool deserialize(JsonDocument& doc, TInput* input, size_t inputSize, SerializationFormat format = JSON_FORMAT_DEFAULT)
387 template <> inline bool deserialize(JsonDocument& doc, CString& input, SerializationFormat format)
399 inline bool loadFromFile(JsonDocument& doc, const String& filename, SerializationFormat format = JSON_FORMAT_DEFAULT)
bool getValueChanged(const TSource &source, TDest &dest)
Copies a Json data value to a variable, but only if it exists and its value has changed.
Definition: ArduinoJson.h:96
bool loadFromFile(JsonDocument &doc, const String &filename, SerializationFormat format=JSON_FORMAT_DEFAULT)
Parses the contents of a serialized file into a JsonDocument object.
Definition: ArduinoJson.h:399
bool saveToFile(const TSource &source, const String &filename, SerializationFormat format=JSON_FORMAT_DEFAULT)
Save a Json object to a file in a specified format.
Definition: ArduinoJson.h:257
bool getValue(const TSource &source, TDest &dest)
Copies a Json data value to a variable, but only if it exists.
Definition: ArduinoJson.h:80
Class to manage a NUL-terminated C-style string When storing persistent strings in RAM the regular St...
Definition: CString.h:26
bool isValid() const override
Determine if the stream object contains valid data.
Definition: IFS/FileStream.h:104
Definition: ArduinoJson.h:57
SerializationFormat
Describes format of serialized Json object.
Definition: ArduinoJson.h:114
size_t measure(const TSource &source, SerializationFormat format=JSON_FORMAT_DEFAULT)
Compute the size of a serialized Json object for a specified format.
Definition: ArduinoJson.h:132
int getLastError()
determine if an error occurred during operation
Definition: FsBase.h:48
bool deserialize(JsonDocument &doc, TInput &input, SerializationFormat format=JSON_FORMAT_DEFAULT)
Read a JsonDocument from formatted data.
Definition: ArduinoJson.h:309
SerializationFormat operator++(SerializationFormat &fmt)
Definition: ArduinoJson.h:120
size_t serialize(const TSource &source, TDestination &destination, SerializationFormat format=JSON_FORMAT_DEFAULT)
Write a Json object in a specified format.
Definition: ArduinoJson.h:160
bool deserializeInternal(JsonDocument &doc, TInput &input, SerializationFormat format=JSON_FORMAT_DEFAULT)
Definition: ArduinoJson.h:272