Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

StreamPeerGZIP

Expérimental : This class may be changed or removed in future versions.

Hérite de : StreamPeer < RefCounted < Object

Un pair de flux qui gère la compression/décompression GZIP et deflate.

Description

Cette classe permet de compresser ou de décompresser des données utilisant GZIP/deflate à la manière d'un flux. Ceci est particulièrement utile lorsque vous compressez ou décompressez des fichiers qui doivent être envoyés par le réseau sans avoir besoin de tous les allouer en mémoire.

Après avoir démarré le flux via start_compression() (ou start_decompression()), appeler StreamPeer.put_partial_data() sur ce flux compressera (ou décompressera) les données, les écrivant dans le buffer interne. L'appel à StreamPeer.get_available_bytes() renverra les octets en attente dans le buffer interne, et StreamPeer.get_partial_data() récupérera les octets compressés (ou décompressés). Lorsque le flux est terminé, vous devez appeler finish() pour garantir que le buffer interne est correctement vidé (assurez vous d'appeler StreamPeer.get_available_bytes() une dernière fois pour vérifier si d'autres données doivent être lues après cela).

Méthodes

void

clear()

Error

finish()

Error

start_compression(use_deflate: bool = false, buffer_size: int = 65535)

Error

start_decompression(use_deflate: bool = false, buffer_size: int = 65535)


Descriptions des méthodes

void clear() 🔗

Vide le flux, réinitialisant l'état interne.


Error finish() 🔗

Finalise le flux, compressant n'importe quel morceau du buffer restant.

Vous ne devez l'appeler seulement que quand vous compressez.


Error start_compression(use_deflate: bool = false, buffer_size: int = 65535) 🔗

Démarre le flux en mode compression avec la taille de buffer buffer_size donnée. Si use_deflate vaut true, utilise deflate au lieu de GZIP.


Error start_decompression(use_deflate: bool = false, buffer_size: int = 65535) 🔗

Démarre le flux en mode décompression avec la taille de buffer buffer_size donnée. Si use_deflate vaut true, utilise deflate au lieu de GZIP.