Quiret at 23:49, 16 January 2022

2022-01-16T23:49:01Z

← Older revision		Revision as of 23:49, 16 January 2022
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	boolean file.eof ()		boolean file:eof ()
	</syntaxhighlight>		</syntaxhighlight>

Line 19:		Line 19:

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

Line 27:		Line 27:

	-- Clean up the file/stream handle and return the result buffer.		-- Clean up the file/stream handle and return the result buffer.
	theFile.destroy();		theFile:destroy();
	return buffer;		return buffer;
	end		end

The GTA: 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 i..."

2014-01-31T14:55:38Z

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 i..."

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>
{{:MTA:Eir/FileSystem/file/functions}}

MTA:Eir/FileSystem/file/eof - Revision history

Quiret at 23:49, 16 January 2022

The GTA: 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 i..."

The GTA: 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 i..."