Difference between revisions of "ChucK/Dev/IO/FileIO"
From CSWiki
| Line 2: | Line 2: | ||
==FileIO Class== | ==FileIO Class== | ||
| − | The <tt>FileIO</tt> class is a subclass of the [[ChucK/Dev/IO#IO_Class|<tt>IO</tt>]] class. Only elements of the <tt>FileIO</tt> class that extend or override the parent class are listed here. | + | The <tt>FileIO</tt> class is a subclass of the [[ChucK/Dev/IO#IO_Class|<tt>IO</tt>]] class. Only elements of the <tt>FileIO</tt> class that extend or override the parent class are listed here. Only files of up to 2 GiB in size are supported by this class. |
===Methods=== | ===Methods=== | ||
Revision as of 20:29, 6 March 2008
The following is subject to change.
FileIO Class
The FileIO class is a subclass of the IO class. Only elements of the FileIO class that extend or override the parent class are listed here. Only files of up to 2 GiB in size are supported by this class.
Methods
-
fun int open(string path[, int flags]) - Opens the specified file, returning true on success and false otherwise. The flags can optionally be used to specify the mode in which to open the file (
FileIO.MODE_READ_WRITEby default). -
fun void seek(int pos) - Seeks to the specified byte offset from the start of the file.
-
fun int size() - Returns the size of the file in bytes, or -1 if a file is not open.
Directories
-
fun int isDir() - Returns true if the opened file is a directory, false otherwise.
-
fun string[] dirList() - Returns an array containing the names of each file in the opened directory, or an empty array if the opened file is not a directory.
Constants
-
FileIO.stdinFileIO.stdout - Pre-created files for reading from and writing to stdin and stdout.
-
FileIO.MODE_READ_WRITEFileIO.MODE_READONLYFileIO.MODE_WRITEONLYFileIO.MODE_APPEND - These flags can optionally be passed to the
openfunction to specify the mode in which to open the file.
