From 34b6922caafe0138668859864adda19c4b803946 Mon Sep 17 00:00:00 2001 From: George Marques Date: Mon, 19 Jun 2017 16:52:01 -0300 Subject: [PATCH] Add documentation to compression functions --- doc/base/classes.xml | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 2331d49c1f1..09ddb769b6b 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -15299,6 +15299,19 @@ Open the file for writing or reading, depending on the flags. + + + + + + + + + + + Open a compressed file for reading or writing. The compression_mode can be set as one of the COMPRESSION_* constants. + + @@ -15445,6 +15458,15 @@ Open the file for reading and writing. Create it if the file not exists and truncate if it exists. + + Use the FastLZ compression method. + + + Use the Deflate compression method. + + + Use the Zstd compression method. + @@ -33733,6 +33755,26 @@ Append an [PoolByteArray] at the end of this array. + + + + + + + Returns a new [PoolByteArray] with the data compressed. The compression mode can be set using one of the COMPRESS_* constants of [File]. + + + + + + + + + + + Returns a new [PoolByteArray] with the data decompressed. The buffer_size should be set as the size of the uncompressed data. The compression mode can be set using one of the COMPRESS_* constants of [File]. + +