JsonDocument::set()

Description

JsonDocument::set() replaces the root value of the JsonDocument.

Signatures

bool set(bool value) const;

bool set(float value) const;
bool set(double value) const;

bool set(signed char value) const;
bool set(signed long value) const;
bool set(signed int value) const;
bool set(signed short value) const;
bool set(unsigned char value) const;
bool set(unsigned long value) const;
bool set(unsigned int value) const;
bool set(unsigned short value) const;

bool set(char *value) const;
bool set(const char *value) const;  // ⚠️ stores by pointer
bool set(const __FlashStringHelper *value) const;  // stores by copy

bool set(const String &value) const;
bool set(const std::string &value) const;
bool set(const Printable& value);
bool set(std::string_view value);

bool set(JsonArray array) const;
bool set(JsonObject object) const;
bool set(JsonVariant variant) const;
bool set(const JsonVariant& doc) const;

bool set(TEnum value) const;  // alias of set(int)
bool set(T value) const;      // calls user-defined function

Arguments

value: the new value of the document, it can be any type supported by ArduinoJson or a user-defined type if you define custom converters.

If you pass a JsonArray, a JsonObject, or a JsonVariant, JsonDocument::set() makes a complete clone of the argument. In other words, the value is stored by copy, not by reference.

As usual, ArduinoJson makes a copy of a string in the JsonDocument, except if it’s a const char*.

Return value

JsonDocument::set() returns a bool that tells whether the operation was successful or not:

  • true if the value operation was successful.
  • false if there was not enough room in the JsonDocument.

String duplication

ArduinoJson makes a copy of the string when you call this function with one of the following types:

User-defined types

JsonDocument::set() supports user-defined types by calling convertToJson(). For example, to support tm, you must define:

bool convertToJson(const tm& src, JsonVariant dst) {
  char buf[32];
  strftime(buf, sizeof(buf), "%FT%TZ", &src);
  return dst.set(buf);
}

Example

JsonDocument doc;
doc.set("hello world")
serializeJson(doc, Serial);

The above program produces the following output:

"hello world"

See also