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.
Properties
Default
|
Returns default compression level for current compression driver.
|
Max
|
Returns the maximum compression level for the current compression driver. Of course you know, that the maximum compression means the slowest algorithm.
|
Min
|
Returns the minimum compression level for the current compression driver. Of course you know, that the minimum compression means the fastest algorithm.
|
Type
|
Before you can use any of the methods provided by this class, you have to select the compression driver to use.
|
Inherited properties
Blocking
|
Returns or sets if the stream is blocking.
|
ByteOrder
|
Returns or sets the byte order used to read or write binary data to the stream.
|
EndOfFile
|
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.
|
EndOfLine
|
Return or set the newline separator used by this stream.
|
Eof
|
Return if a stream reached its end.
|
Handle
|
Returns the system file descriptor associated with this Stream.
|
IsTerm
|
Return if a stream is associated with a terminal.
|
Lines
|
Returns a virtual object that allows you to enumerate a stream line by line.
|
NoShare
|
|
NullTerminatedString
|
Return or set if strings are null-terminated when they are serialized.
|
Tag
|
Returns or sets the tag associated with the stream.
|
Term
|
Return a virtual object that allows to manage the terminal associated with the stream.
|
Methods
File
|
Once you have selected the compression driver, you can compress a file and place the result in another file using this method.
|
Open
|
Allows you to open a compressed file for reading. Prior to using this method, you have to select the appropiate compression driver.
|
String
|
This function returns a string compressed using the algorithm defined by the Type property.
|
Inherited methods
Begin
|
Start to buffer data written to the stream, so that everything will be sent when the Send method is called.
|
Close
|
Closes the stream.
|
Drop
|
Drop the data that has been buffered since the last call to the Begin method.
|
ReadLine
|
Read a line of text from the stream, like the LINE INPUT instruction.
|
Send
|
Send all the data, in one shot, since the last call to Begin.
|
Watch
|
Start or stop watching the stream file descriptor for reading or writing, after it has been opened.
|