Danilo at 03:12, 23 January 2022

2022-01-23T03:12:36Z

← Older revision		Revision as of 03:12, 23 January 2022
Line 1:		Line 1:
			<pageclass class="#3cc882" subcaption="File function"></pageclass>
	__NOTOC__		__NOTOC__
	This function returns whether the runtime can still read data from the file/stream. This is an implementation defined state that should return false if no data can be immediately received using '''read operations'''. Asynchronous file/stream objects could use this function to return true when new data is available to receive from the socket. If wanting to read an entire file/stream object, this function is more reliable than the [[MTA:Eir/FileSystem/file/size\|file.size]] approach.		This function returns whether the runtime can still read data from the file/stream. This is an implementation defined state that should return false if no data can be immediately received using '''read operations'''. Asynchronous file/stream objects could use this function to return true when new data is available to receive from the socket. If wanting to read an entire file/stream object, this function is more reliable than the [[MTA:Eir/FileSystem/file/size\|file.size]] approach.

Danilo: Created page with "NOTOC This function returns whether the runtime can still read data from the file/stream. This is an implementation defined state that should return false if no data can be immediately received using '''read operations'''. Asynchronous file/stream objects could use this function to return true when new data is available to receive from the socket. If wanting to read an entire file/stream object, this function is more reliable than the MTA:Eir/FileSystem/file/size|f..."

2022-01-19T03:47:58Z

Created page with "__NOTOC__ This function returns whether the runtime can still read data from the file/stream. This is an implementation defined state that should return false if no data can be immediately received using '''read operations'''. Asynchronous file/stream objects could use this function to return true when new data is available to receive from the socket. If wanting to read an entire file/stream object, this function is more reliable than the MTA:Eir/FileSystem/file/size|f..."

New page

__NOTOC__
This function returns whether the runtime can still read data from the file/stream. This is an implementation defined state that should return false if no data can be immediately received using '''read operations'''. Asynchronous file/stream objects could use this function to return true when new data is available to receive from the socket. If wanting to read an entire file/stream object, this function is more reliable than the [[MTA:Eir/FileSystem/file/size|file.size]] approach.

==Syntax==
<syntaxhighlight lang="lua">
boolean file:eof ()
</syntaxhighlight>

==Returns==
Returns true if data is available to be read from the file/stream object. Return '''false''' if data is not immediately available to receive from it.

==Example==
<section name="Client" class="client" show="true">
This snippet is guaranteed to read an entire file/stream object.
<syntaxhighlight lang="lua">
local fileGetContentSafe( theFile )
-- Allocate a string buffer where all information is saved in.
local buffer = "";

-- Read from the stream until it cannot anymore.
while not ( theFile:eof() ) do
buffer = buffer .. theFile:read( 1024 );
end

-- At this point, some implementations could wait for data.
-- Implementations are advised to use blocking I/O, implement additional Lua functions or throw exceptions.

-- Clean up the file/stream handle and return the result buffer.
theFile:destroy();
return buffer;
end
</syntaxhighlight>
</section>
{{:Modules/FileSystem/file/functions}}

Modules/FileSystem/file/eof - Revision history

Danilo at 03:12, 23 January 2022