Libraries.System.BinaryFileReader Documentation

The BinaryFileReader class is used to read files written in binary, one byte at a time. The primary purpose is to store the bytes into an array for easy reading and access of the files.

Example Code

use Libraries.System.BinaryFileReader
    use Libraries.Containers.ByteArray
    use Libraries.System.File

    class Main
        action Main
            BinaryFileReader reader
            ByteArray array
            File file
            file:SetWorkingDirectory("/system/fonts/Arial.ttf")
            reader:OpenForRead(file)
            array = reader:ReadBytes()
        end
    end

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
OpenForRead(Libraries.System.File file, Libraries.Interface.Events.FileLoadListener listener)This action asynchronously loads the file, and when it has completed loading, will call the FileLoadListener's OnLoad() action.
OpenForRead(Libraries.System.File file)This action opens the file specified so that it can be read from.
ReadBytes()This action reads the binary file, reading it a byte at a time, and stores the bytes into a ByteArray, which is then returned.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

OpenForRead(Libraries.System.File file, Libraries.Interface.Events.FileLoadListener listener)

This action asynchronously loads the file, and when it has completed loading, will call the FileLoadListener's OnLoad() action.

Parameters

OpenForRead(Libraries.System.File file)

This action opens the file specified so that it can be read from.

Example Code

use Libraries.System.BinaryFileReader
    use Libraries.System.File
    BinaryFileReader reader
    File file
    file:SetWorkingDirectory("/system/fonts/Arial.ttf")
    reader:OpenForRead(file)

Parameters

ReadBytes()

This action reads the binary file, reading it a byte at a time, and stores the bytes into a ByteArray, which is then returned.

Example Code

use Libraries.System.BinaryFileReader
    use Libraries.Containers.ByteArray
    use Libraries.System.File
    BinaryFileReader reader
    ByteArray array
    File file
    file:SetWorkingDirectory("/system/fonts/Arial.ttf")
    reader:OpenForRead(file)
    array = reader:ReadBytes()

Return

Libraries.Containers.ByteArray: Returns a ByteArray.