Quiret at 23:50, 16 January 2022

2022-01-16T23:50:39Z

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

Line 16:		Line 16:
	local function readHeader( theFile )		local function readHeader( theFile )
	-- Check whether we can read anything from the file.		-- Check whether we can read anything from the file.
	if not ( theFile.isReadable() ) then		if not ( theFile:isReadable() ) then
	error( "fatal error: file cannot be read from" );		error( "fatal error: file cannot be read from" );
	end		end
Line 22:		Line 22:
	-- Read the generic header back into the engine.		-- Read the generic header back into the engine.
	local headerInfo = {		local headerInfo = {
	chunkSize = theFile.readUInt(),		chunkSize = theFile:readUInt(),
	version = theFile.readFloat(),		version = theFile:readFloat(),
	isRaw = theFile.readBoolean()		isRaw = theFile:readBoolean()
	};		};

The GTA: Created page with "NOTOC This function returns whether a stream is readable. If a stream is not readable, then all read operations should result in nil operations (they will return zero bytes r..."

2014-01-31T16:43:57Z

Created page with "__NOTOC__ This function returns whether a stream is readable. If a stream is not readable, then all read operations should result in nil operations (they will return zero bytes r..."

New page

__NOTOC__
This function returns whether a stream is readable. If a stream is not readable, then all read operations should result in nil operations (they will return zero bytes read or false if value reading). This state should be immutable across the lifetime of a file/stream class.

==Syntax==
<syntaxhighlight lang="lua">
boolean file.isReadable ()
</syntaxhighlight>

==Returns==
Returns '''true''' if the file/stream is readable, '''false''' otherwise.

==Example==
<section name="Client" class="client" show="true">
This snippet is the counterpart of the [[MTA:Eir/FileSystem/file/isWritable|file.isWritable]] example. It attempts to read the header from the file, but throws an exception if it cannot be read from.
<syntaxhighlight lang="lua">
local function readHeader( theFile )
-- Check whether we can read anything from the file.
if not ( theFile.isReadable() ) then
error( "fatal error: file cannot be read from" );
end

-- Read the generic header back into the engine.
local headerInfo = {
chunkSize = theFile.readUInt(),
version = theFile.readFloat(),
isRaw = theFile.readBoolean()
};

-- Return the header information.
return headerInfo;
end
</syntaxhighlight>
</section>
{{:MTA:Eir/FileSystem/file/functions}}

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

Quiret at 23:50, 16 January 2022

The GTA: Created page with "__NOTOC__ This function returns whether a stream is readable. If a stream is not readable, then all read operations should result in nil operations (they will return zero bytes r..."

The GTA: Created page with "NOTOC This function returns whether a stream is readable. If a stream is not readable, then all read operations should result in nil operations (they will return zero bytes r..."