Decompressor

class Decompressor

This manages run-time decompression of a zlib-compressed stream, as a background or foreground task.

Inheritance diagram

digraph inheritance9d06f65a0b { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; "Decompressor" [URL="acron.core.Decompressor.html#acron.core.Decompressor",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "Decompressor" [arrowsize=0.75,style=""]; }
Decompressor.__init__()
Decompressor.decompress()

Performs a foreground decompression of the named file; does not return until the decompression is complete.

Does an in-memory decompression of the indicated Ramfile. The decompressed contents are written back into the same Ramfile on completion.

Decompressor.get_progress()

Returns the ratio through the decompression step in the background.

Decompressor.initiate()

Begins a background decompression of the named file (whose filename must end in “.pz”) to a new file without the .pz extension. The source file is removed after successful completion.

Begins a background decompression from the named source file to the named destination file. The source file is removed after successful completion.

Decompressor.run()

Called each frame to do the next bit of work in the background task. Returns EU_ok if a chunk is completed but there is more to go, or EU_success when we’re all done. Any other return value indicates an error.