Objeck Documentation

Bundle Supports filesystem operations

FileReader

Supports file read operations

Inherits: File

reader := System.IO.FileReader->New("data.txt");
while(reader->IsEOF() <> true) {
  line := reader->ReadLine();
  line->PrintLine();
};
reader->Close();

Operations

New
Close
ReadBinaryFile
ReadBuffer
ReadByte
ReadFile
ReadLine

Close #

Closes the file

method : public : Close() ~ Nil

Example

reader := System.IO.FileReader->New("file.txt");
# ... read operations ...
reader->Close();

New # constructor

Default constructor.

New(name:System.String)

Parameters

Name	Type	Description
name	String	filename

ReadBinaryFile # function

Reads a file's contents into byte array

function : ReadBinaryFile(name:String) ~ Byte[]

Parameters

Name	Type	Description
name	String	filename

Return

Type	Description
Byte	byte array, Nil if file is not found

ReadBuffer #

Reads bytes into a character buffer

method : public : ReadBuffer(offset:Int, num:Int, buffer:Char[]) ~ Int

Parameters

Name	Type	Description
offset	Int	destination buffer offset
num	Int	number of values to read
buffer	Char	input buffer

Return

Type	Description
Int	number of values read

ReadBuffer #

Reads bytes into a byte buffer

method : public : ReadBuffer(offset:Int, num:Int, buffer:Byte[]) ~ Int

Parameters

Name	Type	Description
offset	Int	destination buffer offset
num	Int	number of values to read
buffer	Byte	input buffer

Return

Type	Description
Int	number of values read

ReadByte #

Reads a byte

method : public : ReadByte() ~ Byte

Return

Type	Description
Byte	byte read

Example

reader := System.IO.FileReader->New("data.bin");
b := reader->ReadByte();
b->PrintLine();
reader->Close();

ReadFile # function

Reads a file's contents into a string

function : ReadFile(name:String) ~ String

Parameters

Name	Type	Description
name	String	filename

Return

Type	Description
String	character string, Nil if file is not found

Example

content := System.IO.FileReader->ReadFile("readme.txt");
if(content <> Nil) {
  content->PrintLine();
};

ReadLine #

Reads a string until a newline or character return is detected

method : public : ReadLine() ~ System.String

Return

Type	Description
String	character string

Example

reader := System.IO.FileReader->New("log.txt");
line := reader->ReadLine();
while(line <> Nil) {
  line->PrintLine();
  line := reader->ReadLine();
};
reader->Close();