FileTools[Compressed]
ReadFile
read an entire compressed file
Calling Sequence
Parameters
Options
Description
Examples
Compatibility
ReadFile(filename, outputtype, opts)
filename
-
string, or string in string
outputtype
(optional) either string, ByteArray, or 'Array'(m,n,hwdatatype)
opts
(optional) options as specified below
format : bzip2, zip, or gzip ; specify the input format explicitly
ReadFile is an all-in-one command to open a file, read and decompress its data, and close the file.
If the given file is in zip format, and an in-zip name is not specified (using "subfile" in "zipfile"), then the first member of the zip archive is read.
If the second parameter, outputtype, is string then the contents of the file are returned as a string.
If the outputtype is not specified and the in-zip file name ends in ".m", then the contents of the zip file will be parsed as if they were in Maple's internal object format.
If the outputtype is not specified and the in-zip file name ends in ".mpl", then the contents of the zip file will be parsed as if they were a single Maple-syntax text command.
If outputtype is Array, then m and n are integers specifying the dimensions of the Array. The dimensions are optional, and one or more can be set. The hwdatatype indicates one of the integer[], float[], or complex[] datatype variations accepted by the 'datatype' option of the Array command.
If outputtype is set to bytes or does not match any of the above criteria then an Array of datatype integer[1] is returned.
Read from a file in gzip format.
file≔FileToolsTemporaryFilename⁡FileToolsJoinPath⁡FileToolsTemporaryDirectory⁡,GZtest-
file≔/tmp/mpldoc2/GZtest-yYoYxV9R
FileToolsCompressedWriteFile⁡file,This is a test
14
FileToolsCompressedReadFile⁡file,string
This is a test
FileToolsCompressedWriteFile⁡file,Array⁡1..50,0,datatype=integer1
50
FileToolsCompressedReadFile⁡file
00000000000000000000000000000000000000000000000000
FileToolsRemove⁡file
Read from a file in zip format.
zipfile≔FileToolsTemporaryFilename⁡cat⁡FileToolsTemporaryDirectory⁡,kernelopts⁡dirsep,GZtest-,.zip
zipfile≔/tmp/mpldoc2/GZtest-bx70dpPu.zip
FileTools[Compressed][WriteFile]("first" in zipfile, "one");
3
FileTools[Compressed][WriteFile]("second" in zipfile, Array(1..50, 0, datatype=integer[1]));
FileToolsCompressedContents⁡zipfile
first,second
FileToolsCompressedReadFile⁡zipfile,string
one
FileTools[Compressed][ReadFile]("second" in zipfile);
FileToolsRemove⁡zipfile
The FileTools[Compressed][ReadFile] command was introduced in Maple 16.
For more information on Maple 16 changes, see Updates in Maple 16.
See Also
FileTools[Compressed][WriteFile]
FileTools[Remove]
StringTools[FromByteArray]
Download Help Document