formatJsonResponse()

fl::string fl::formatJsonResponse	(	const fl::json &	response,
		const char *	prefix = "" )

Serialize JSON response to a string.

Parameters

response	JSON response object
prefix	Optional prefix to prepend (default: "")

Returns

Formatted string ready to be written to output

Note

Generic JSON serialization - works for any JSON, not just JSON-RPC

Definition at line 28 of file serial.cpp.hpp.

                                                                                     {
    // Reuse the serialized body. A second growing stream kept two full copies
    // of large discovery responses alive and could exhaust ESP32's heap.
    fl::string jsonStr = response.to_string();
    const fl::size bodyLength = jsonStr.size();
    const fl::size prefixLength = prefix ? fl::strlen(prefix) : 0;
    if (bodyLength == 0) {
        // to_string() returns empty only when its buffer could not be
        // allocated; never publish a bare prefix (FastLED #4899).
        return outOfMemoryResponse(prefix, prefixLength);
    }
    if (prefixLength != 0) {
        const fl::size totalLength = bodyLength + prefixLength;
        if (totalLength >= bodyLength && totalLength != fl::string::npos) {
            jsonStr.reserve(totalLength);
            jsonStr.write(prefix, prefixLength);
        }
        if (jsonStr.size() != totalLength || totalLength < bodyLength) {
            // Release the large body before allocating the small error reply.
            // A failed extension must not publish partially formed JSON.
            jsonStr.clear(true);
            return outOfMemoryResponse(prefix, prefixLength);
        }
        char *bytes = &jsonStr[0]; // fl-lint: container-data-ptr-ok - contiguous mutable string for memmove/memcpy interop
        fl::memmove(bytes + prefixLength, bytes, bodyLength);
        fl::memcpy(bytes, prefix, prefixLength);
    }
 
    // Preserve prefix bytes; normalize only the serialized body in place.
    for (fl::size i = prefixLength; i < jsonStr.size(); ++i) {
        char &byte = jsonStr[i];
        if (byte == '\n' || byte == '\r') {
            byte = ' ';
        }
    }
    return jsonStr;
}

References fl::basic_string::clear(), FL_NO_EXCEPT, memcpy(), memmove(), fl::string::npos, fl::basic_string::reserve(), fl::basic_string::size(), strlen(), and fl::basic_string::write().

Here is the call graph for this function: