Leunsel: Initial page creation.

2026-06-21T17:10:17Z

Initial page creation.

New page

[[Category:Lua]]
{{CodeBox|'''class''' FileStream ''':''' HandleStream}}

The FileStream class represents a stream backed by a file on disk.

A FileStream inherits from HandleStream, Stream, and Object. It can be created with createFileStream and is used to read from or write to files.

===Inheritance===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Class
!align="left"|Inherits From
!style="width: 80%;background-color:white;" align="left"|Description
|-
|FileStream
|HandleStream
|A stream object backed by a file on disk.
|-
|HandleStream
|Stream
|Base class for streams that use a handle.
|-
|Stream
|Object
|Base class for stream objects.
|}

===Creation===
{{CodeBox|'''function''' createFileStream(''filename'', ''mode'') ''':''' FileStream}}

Creates a FileStream object for the specified file.

The ''mode'' parameter controls how the file is opened or created. File open modes can be combined with file sharing modes using a bitwise or operation.

===Function Parameters===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Parameter
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|filename
|String
|The path to the file to open or create.
|-
|mode
|Integer
|The file open mode. This can be combined with a file sharing mode.
|}

===Returns===
FileStream — The created FileStream object.

===File Open Modes===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Constant
!align="left"|Value
!style="width: 80%;background-color:white;" align="left"|Description
|-
|fmCreate
|0xff00
|Creates a new file. If the file already exists, it is overwritten.
|-
|fmOpenRead
|Integer
|Opens the file for reading.
|-
|fmOpenWrite
|Integer
|Opens the file for writing.
|-
|fmOpenReadWrite
|Integer
|Opens the file for both reading and writing.
|}

===File Sharing Modes===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Constant
!align="left"|Value
!style="width: 80%;background-color:white;" align="left"|Description
|-
|fmShareCompat
|0x0000
|Uses compatibility sharing mode.
|-
|fmShareExclusive
|0x0010
|Prevents other processes from opening the file.
|-
|fmShareDenyWrite
|0x0020
|Prevents other processes from opening the file for writing.
|-
|fmShareDenyRead
|0x0030
|Prevents other processes from opening the file for reading.
|-
|fmShareDenyNone
|0x0040
|Allows other processes to open the file for reading or writing.
|}

===Properties===
This class has no documented properties.

===Methods===
This class has no documented methods beyond the inherited stream methods.

===Examples===
<pre>
local stream = createFileStream("C:\\\\Temp\\\\example.bin", fmCreate)

stream.writeByte(0x41)
stream.writeByte(0x42)
stream.writeByte(0x43)

stream.destroy()
</pre>

<pre>
local mode = fmOpenReadWrite | fmShareDenyNone
local stream = createFileStream("C:\\\\Temp\\\\example.bin", mode)

print("FileStream: " .. tostring(stream))

stream.destroy()
</pre>

{{LuaSeeAlso}}

Lua:Class:FileStream - Revision history

Leunsel: Initial page creation.