play-json icon indicating copy to clipboard operation
play-json copied to clipboard

Add support for writing to an output stream

Open here-abarany opened this issue 1 year ago • 0 comments

Pull Request Checklist

  • [x] Have you read through the contributor guidelines?
  • [x] Have you squashed your commits?
  • [x] Have you added copyright headers to new files?
  • [x] Have you updated the documentation?
  • [x] Have you added tests for any changed functionality?

Fixes

Fixes #1126

Purpose

Added JsonFacade functions writeToStream and prettyPrintToStream to support writing to an OutputStream without first writing the full string to memory.

Background Context

This allows for writing large files to a stream (such as to a file) without having to buffer the full string in memory beforehand. The JVM implementation forwards these calls to the appropriate functions in Jackson.

For now, the non-JVM implementations will build up the full string in memory. Ideally the strings should be written out as they are built up, but this would require a refactoring of the fromJs() function to support an interface to feed each string value and minimize the number of conversions to UTF-8 (for toBytes and writing to stream) or avoid conversions (for String). For now, this fulfills the interface guarantee while providing the same level of functionality as before.

here-abarany avatar Feb 14 '25 03:02 here-abarany