Index · Object → RefCounted → StreamPeer → StreamPeerGZIP

StreamPeerGZIP

A stream peer that handles GZIP and deflate compression/decompression.

Class 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 have to be sent through the network without needing to allocate them all in memory.

After starting the stream via start_compression() (or start_decompression()), calling StreamPeer.put_partial_data() on this stream will compress (or decompress) the data, writing it to the internal buffer. Calling StreamPeer.get_available_bytes() will return the pending bytes in the internal buffer, and StreamPeer.get_partial_data() will retrieve the compressed (or decompressed) bytes from it. When the stream is over, you must call finish() to ensure the internal buffer is properly flushed (make sure to call StreamPeer.get_available_bytes() on last time to check if more data needs to be read after that).

Properties

Inherited from StreamPeer (1)
var big_endian: bool = false

Methods

func clear() -> void

Clears this stream, resetting the internal state.

func finish() -> Error

Finalizes the stream, compressing any buffered chunk left.

You must call it only when you are compressing.

func start_compression(use_deflate: bool = false, buffer_size: int = 65535) -> Error

Start the stream in compression mode with the given buffer_size, if use_deflate is true uses deflate instead of GZIP.

func start_decompression(use_deflate: bool = false, buffer_size: int = 65535) -> Error

Start the stream in decompression mode with the given buffer_size, if use_deflate is true uses deflate instead of GZIP.

Inherited from StreamPeer (33)
func get_8() -> int
func get_16() -> int
func get_32() -> int
func get_64() -> int
func get_data(bytes: int) -> Array
func get_double() -> float
func get_float() -> float
func get_half() -> float
func get_partial_data(bytes: int) -> Array
func get_string(bytes: int = -1) -> String
func get_u8() -> int
func get_u16() -> int
func get_u32() -> int
func get_u64() -> int
func get_utf8_string(bytes: int = -1) -> String
func get_var(allow_objects: bool = false) -> Variant
func put_8(value: int) -> void
func put_16(value: int) -> void
func put_32(value: int) -> void
func put_64(value: int) -> void
func put_data(data: PackedByteArray) -> Error
func put_double(value: float) -> void
func put_float(value: float) -> void
func put_half(value: float) -> void
func put_string(value: String) -> void
func put_u8(value: int) -> void
func put_u16(value: int) -> void
func put_u32(value: int) -> void
func put_u64(value: int) -> void
func put_utf8_string(value: String) -> void
func put_var(value: Variant, full_objects: bool = false) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)