Difference between revisions of "ChucK/Dev/IO/FileIO"

From CSWiki
Jump to: navigation, search
Line 5: Line 5:
  
 
===Methods===
 
===Methods===
; <code>fun int open(string path[, int flags])</code> : 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 (<code>FileIO.MODE_READ_WRITE</code> by default).
+
; <code>fun int open(string path[, int flags])</code> : 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 (<code>FileIO.MODE_READ_WRITE | FileIO.MODE_ASCII</code> by default).
 
; <code>fun void seek(int pos)</code> : Seeks to the specified byte offset from the start of the file.
 
; <code>fun void seek(int pos)</code> : Seeks to the specified byte offset from the start of the file.
 
; <code>fun int size()</code> : Returns the size of the file in bytes, or -1 if a file is not open.
 
; <code>fun int size()</code> : Returns the size of the file in bytes, or -1 if a file is not open.
Line 16: Line 16:
 
; <code>FileIO.stdin</code><br /><code>FileIO.stdout</code> : Pre-created files for reading from and writing to <tt>stdin</tt> and <tt>stdout</tt>.
 
; <code>FileIO.stdin</code><br /><code>FileIO.stdout</code> : Pre-created files for reading from and writing to <tt>stdin</tt> and <tt>stdout</tt>.
 
; <code>FileIO.MODE_READ_WRITE</code><br /><code>FileIO.MODE_READONLY</code><br /><code>FileIO.MODE_WRITEONLY</code><br /><code>FileIO.MODE_APPEND</code> : These flags can optionally be passed to the <code>open</code> function to specify the mode in which to open the file.
 
; <code>FileIO.MODE_READ_WRITE</code><br /><code>FileIO.MODE_READONLY</code><br /><code>FileIO.MODE_WRITEONLY</code><br /><code>FileIO.MODE_APPEND</code> : These flags can optionally be passed to the <code>open</code> function to specify the mode in which to open the file.
 +
; <code>FileIO.MODE_ASCII</code><br /><code>FileIO.MODE_BINARY</code> : These flags can optionally be passed to the <code>open</code> function to specify whether reading and writing should proceed in ASCII (readable text) or binary mode.
  
 
===Examples===
 
===Examples===

Revision as of 21:01, 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_WRITE | FileIO.MODE_ASCII by 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.stdin
FileIO.stdout 
Pre-created files for reading from and writing to stdin and stdout.
FileIO.MODE_READ_WRITE
FileIO.MODE_READONLY
FileIO.MODE_WRITEONLY
FileIO.MODE_APPEND 
These flags can optionally be passed to the open function to specify the mode in which to open the file.
FileIO.MODE_ASCII
FileIO.MODE_BINARY 
These flags can optionally be passed to the open function to specify whether reading and writing should proceed in ASCII (readable text) or binary mode.

Examples