From 22d4df73f6255f74c66878246520722fa8fe4467 Mon Sep 17 00:00:00 2001 From: bol-van Date: Wed, 7 Jan 2026 06:36:14 +0300 Subject: [PATCH] update docs --- docs/manual.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/manual.md b/docs/manual.md index 711176c..f12c14b 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -1937,6 +1937,7 @@ function gunzip_inflate(zstream, compressed_data, expected_uncompressed_chunk_si * gunzip_init создает и возвращает контекст gzip потока для последующих вызовов других функций. Значение windowBits см. в документации по zlib (по умолчанию 47). * gunzip_end освобождает контекст gzip. может быть освобожден сборщиком мусора, но лучше вызывать явно. * gunzip_inflate разжимает очередную часть зипованных данных. Данные можно скармливать частями. Расжатые части конкатенируются для получения полных данных. Возвращается 2 аргумента : расжатые данные и bool признак конца gzip. В случае испорченных данных или при нехватке памяти возвращается nil. +* expected_uncompressed_chunk_size - необязательный параметр для оптимизации выделения памяти под расжимаемые данные. Если буфера не хватает, вызываются realloc, что влияет на производительность. По умолчанию - четырехкратный размер compressed_data. #### gzip @@ -1949,7 +1950,7 @@ function gzip_deflate(zstream, uncompressed_data, expected_compressed_chunk_size * gzip_init создает и возвращает контекст gzip потока для последующих вызовов других функций. Значение windowBits см. в документации по zlib (по умолчанию 31). level - уровень сжатия от 1 до 9 (по умолчанию 9), memlevel - допустимый уровень использования памяти от 1 до 8 (по умолчанию 8). * gzip_end освобождает контекст gzip. может быть освобожден сборщиком мусора, но лучше вызывать явно. * gzip_deflate cжимает очередную часть данных. Данные можно скармливать частями. Cжатые части конкатенируются для получения полных данных. Для финализации потока по окончанию скармливания данных функция должна быть вызвана с uncompressed_data=nil или uncompressed_data="". Возвращается 2 аргумента : сжатые данные и bool признак конца gzip. При ошибках gzip или нехватке памяти возвращается nil. - +* expected_compressed_chunk_size - необязательный параметр для оптимизации выделения памяти под cжимаемые данные. Если буфера не хватает, вызываются realloc, что влияет на производительность. По умолчанию - четверть размера uncompressed_data. ### Системные функции @@ -3090,7 +3091,7 @@ true, если файл является gzip, иначе false. При ошиб function gunzip_file(filename, read_block_size) ``` -Расжимает файл и возвращает raw string. В случае ошибки открытия или чтения файла вызывается error. При испорченных gzip данных или нехватке памяти возвращается nil. read_block_size - частями какого размера читается файл (по умолчанию 16K). +Расжимает файл и возвращает raw string. В случае ошибки открытия или чтения файла вызывается error. При нехватке памяти возвращается nil. read_block_size - частями какого размера читается файл (по умолчанию 16K). ``` function gzip_file(filename, data, level, memlevel, compress_block_size)