Gambas Documentation - /comp/gb.compress/compress

# Compress (gb.compress)

This class allows Gambas to use compression algorithms, in order to compress files, strings in memory, and to write a compressed file using standard Stream methods.

This class inherits Stream in gb.
This class is
Creates a new Compress object.
creatable
.

Properties | Methods
--- | ---

Returns or sets if the stream is blocking.
Blocking
Returns or sets the byte order used to read or write binary data to the stream.
ByteOrder
Returns default compression level for current compression driver.
Default
This property signals whether the last use of LINE INPUT reached the end of file, instead of reading a full line with an end-of-line character.
EndOfFile
Returns or sets the newline separator used by this stream.
EndOfLine
Returns the system file descriptor associated with this Stream.
Handle
Returns a virtual object that allows you to enumerate a stream line by line.
Lines
Returns the maximum compression level for the current compression driver. Of course you know, that the maximum compression means the slowest algorithm.
Max
Returns the minimum compression level for the current compression driver. Of course you know, that the minimum compression means the fastest algorithm.
Min
Returns or sets the tag associated with the stream.
Tag
Before you can use any of the methods provided by this class, you have to select the compression driver to use.
Type

Start to buffer data written to the stream, so that everything will be sent when the Send method is called.
Begin
Closes the stream.
Close
Drop the data that has been buffered since the last call to the Begin method.
Drop
Once you have selected the compression driver, you can compress a file and place the result in another file using this method.
File
Allows you to open a compressed file for reading. Prior to using this method, you have to select the appropiate compression driver.
Open
Read a line of text from the stream, like the LINE INPUT instruction.
ReadLine
Send all the data, in one shot, since the last call to Begin.
Send
This function returns a string compressed using the algorithm defined by the Type property.
String