Remove temporary buffer in ConfigFile.ino #8298
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
Thank you guys for maintaining this critical piece of software that is at the heart of so many projects 👍
This PR simplifies the
ConfigFile.ino
example by removing the temporary buffer and passing theFile
directly todeserializeJson()
.When reading from a
Stream
, using a temporary buffer is counterproductive because it complexifies the code and increases memory usage. It's also a source of confusion because it can create dangling pointers in theJsonDocument
.The only benefit of using a buffer is the reading speed, but I don't think speed is the focus in this example; if it were, it would use a buffer in
saveConfig()
too.By the way, this example has been the origin of many issues in ArduinoJson's tracker:
It seems that I've been doing the customer service for this example, so I wonder if it's wise to keep it considering there is a comparable example in ArduinoJson, with the differences that it uses SD instead of LittleFS and it shows how to apply best practices by copying the data in a
struct
.Please let me know what you think.
Best regards,
Benoit