Interface Compressor
access this type via: compress.Compressor (provides, requires or uses)
--- semantic variants: gzip
Compression API to compress data into a particular file format.
Functions
bool compress(File ifd, File ofd, optional char filename[])
bool decompress(File ifd, File ofd)
char[] getFileName(File ifd)
bool compress(File ifd, File ofd, optional char filename[])
Reads all data from ifd, starting from the current read position, and compresses it into ofd. The compressed data will include a file header and other meta-data, according to the compression format being used.
ifd The file from which input data (usually uncompressed) is read.
ofd The file to which compressed data (including file headers and meta-data) is written.
returns: True if successful, false otherwise.
bool decompress(File ifd, File ofd)
Reads compressed data from ifd, starting from the current read position, and decompresses it into ofd.
ifd The file from which compressed input data is read.
ofd The file to which uncompressed data is written.
returns: True if successful, false otherwise.
char[] getFileName(File ifd)
Reads the filename of the compressed data from ifd (if the compression format supports filenames).
ifd The file from which compressed input data is read.
returns: The filename of the compressed file (if any).