BinaryFile Service

The BinaryFile service allows you to read from and write into binary files.


enum BinaryFile.OpenMode { ReadOnly, WriteOnly, ReadWrite }

List of modes that a file may be opened in.

The OpenMode values can be combined with the bitwise or operator.

Available operations


BinaryFile(filePath: string, openMode: OpenMode = BinaryFile.ReadOnly)

Opens the file at filePath in the given mode and returns the object representing the file.

Note: The mode influences which of the operations listed below can actually be used on the file.


atEof(): boolean

Returns true if no more data can be read from the file, false otherwise.


close(): void

Closes the file. It is recommended to always call this function as soon as you are finished with the file, in order to keep the number of in-flight file descriptors as low as possible.


filePath(): string

The absolute path of the file represented by this object.


size(): number

Returns the size of the file (in bytes).


resize(size: number): void

Sets the file size (in bytes). If size is larger than the file currently is, the new bytes will be set to 0; if size is smaller, the file is truncated.


pos(): number

Returns the position that data is written to or read from.


seek(pos: number): void

Sets the current position to pos.


read(size: number): number[]

Reads at most size bytes of data from the file and returns it as an array.


write(data: number[]): void

Writes data into the file at the current position.

© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.