diff options
| author | Adam Brown <adamwbrown@gmail.com> | 2020-05-21 01:05:32 -0700 |
|---|---|---|
| committer | Adam Brown <adamwbrown@gmail.com> | 2020-09-02 12:59:59 -0700 |
| commit | 6584db1538fa967faf63bdd6ce32eb9b440b5e6f (patch) | |
| tree | 5bde583d20e6a70af3e143d10374940451eaf2f0 /doc/classes/PackedByteArray.xml | |
| parent | 21907011c1f805219cfa11dfbd35954d9d40360b (diff) | |
| download | redot-engine-6584db1538fa967faf63bdd6ce32eb9b440b5e6f.tar.gz | |
HTTPRequest now accepts gzip
Added request_raw to HttpRequest
Added decompress_dynamic to Compression class
Added decompress_dynamic to BytePoolArray
Merge doc fix
revert
Diffstat (limited to 'doc/classes/PackedByteArray.xml')
| -rw-r--r-- | doc/classes/PackedByteArray.xml | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index 08f8558881..88b30aed8f 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -57,6 +57,20 @@ Returns a new [PackedByteArray] with the data decompressed. Set [code]buffer_size[/code] to the size of the uncompressed data. Set the compression mode using one of [enum File.CompressionMode]'s constants. </description> </method> + <method name="decompress_dynamic"> + <return type="PackedByteArray"> + </return> + <argument index="0" name="max_output_size" type="int" default="0"> + </argument> + <argument index="1" name="compression_mode" type="int" default="0"> + </argument> + <description> + Returns a new [PackedByteArray] with the data decompressed. Set the compression mode using one of [enum File.CompressionMode]'s constants. [b]This method only accepts gzip and deflate compression modes.[/b] + This method is potentially slower than [code]decompress[/code], as it may have to re-allocate it's output buffer multiple times while decompressing, where as [code]decompress[/code] knows it's output buffer size from the begining. + + GZIP has a maximal compression ratio of 1032:1, meaning it's very possible for a small compressed payload to decompress to a potentially very large output. To guard against this, you may provide a maximum size this function is allowed to allocate in bytes via [code]max_output_size[/code]. Passing -1 will allow for unbounded output. If any positive value is passed, and the decompression exceeds that ammount in bytes, then an error will be returned. + </description> + </method> <method name="empty"> <return type="bool"> </return> |