summaryrefslogtreecommitdiffstats
path: root/doc/classes/StreamPeerGZIP.xml
diff options
context:
space:
mode:
authorYuri Sizov <11782833+YuriSizov@users.noreply.github.com>2023-05-29 17:08:40 +0200
committerGitHub <noreply@github.com>2023-05-29 17:08:40 +0200
commit490a76edc85e59440c2d9d868a26fe634c061e7b (patch)
tree5d9a043fac9e50003d997c6c24a41ff9dc35e91f /doc/classes/StreamPeerGZIP.xml
parenta96d1bf4d4e81da7e11424e6b5b730e44cb67757 (diff)
parent04562662d38a83e1ac1fde2af9572ca38147e772 (diff)
downloadredot-engine-490a76edc85e59440c2d9d868a26fe634c061e7b.tar.gz
Merge pull request #76526 from MewPurPur/improve-docs-top-sections-CORE
Overhaul the top sections of the class reference (Core classes)
Diffstat (limited to 'doc/classes/StreamPeerGZIP.xml')
-rw-r--r--doc/classes/StreamPeerGZIP.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/StreamPeerGZIP.xml b/doc/classes/StreamPeerGZIP.xml
index 59fd10ebb8..7166b57f58 100644
--- a/doc/classes/StreamPeerGZIP.xml
+++ b/doc/classes/StreamPeerGZIP.xml
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StreamPeerGZIP" inherits="StreamPeer" is_experimental="true" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
- Stream peer handling GZIP and deflate compression/decompresison.
+ A stream peer that handles GZIP and deflate compression/decompression.
</brief_description>
<description>
- This class allows to compress or decompress data using GZIP/deflate in a streaming fashion. This is particularly useful when compressing or decompressing files that has to be sent through the network without having to allocate them all in memory.
+ This class allows to compress or decompress data using GZIP/deflate in a streaming fashion. This is particularly useful when compressing or decompressing files that have to be sent through the network without needing to allocate them all in memory.
After starting the stream via [method start_compression] (or [method start_decompression]), calling [method StreamPeer.put_partial_data] on this stream will compress (or decompress) the data, writing it to the internal buffer. Calling [method StreamPeer.get_available_bytes] will return the pending bytes in the internal buffer, and [method StreamPeer.get_partial_data] will retrieve the compressed (or decompressed) bytes from it. When the stream is over, you must call [method finish] to ensure the internal buffer is properly flushed (make sure to call [method StreamPeer.get_available_bytes] on last time to check if more data needs to be read after that).
</description>
<tutorials>