Danilo at 03:13, 23 January 2022

2022-01-23T03:13:45Z

← Older revision		Revision as of 03:13, 23 January 2022
Line 1:		Line 1:
			<pageclass class="#3cc882" subcaption="File function"></pageclass>
	__NOTOC__		__NOTOC__
	This function returns whether a stream is writable. If a stream is not writable, then all write operations should result in nil operations (they will return zero bytes written). This state should be immutable across the lifetime of a file/stream class.		This function returns whether a stream is writable. If a stream is not writable, then all write operations should result in nil operations (they will return zero bytes written). This state should be immutable across the lifetime of a file/stream class.

Danilo: Created page with "NOTOC This function returns whether a stream is writable. If a stream is not writable, then all write operations should result in nil operations (they will return zero bytes written). This state should be immutable across the lifetime of a file/stream class. ==Syntax== boolean file:isWritable () ==Returns== Returns '''true''' if the file/stream is writable, '''false''' otherwise. ==Example==

2022-01-19T03:49:18Z

Created page with "NOTOC This function returns whether a stream is writable. If a stream is not writable, then all write operations should result in nil operations (they will return zero bytes written). This state should be immutable across the lifetime of a file/stream class. ==Syntax== <syntaxhighlight lang="lua"> boolean file:isWritable () </syntaxhighlight> ==Returns== Returns '''true''' if the file/stream is writable, '''false''' otherwise. ==Example== <section name="Client" cl..."

New page
NOTOC
This function returns whether a stream is writable. If a stream is not writable, then all write operations should result in nil operations (they will return zero bytes written). This state should be immutable across the lifetime of a file/stream class.

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

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

==Example==
<section name="Client" class="client" show="true">
This snippet implements a file function that makes sure the file it has been passed to for writing actually supports writing.
<syntaxhighlight lang="lua">
local function writeHeader( theFile, headerInfo )
-- Check whether we can write things into the file.
if not ( theFile:isWritable() ) then
error( "fatal error: stream is not writable" );
end

-- Write a generic header structure.
theFile:writeUInt( headerInfo.chunkSize );
theFile:writeFloat( headerInfo.version );
theFile:writeBoolean( headerInfo.isRaw );
end
</syntaxhighlight>
</section>
{{:Modules/FileSystem/file/functions}}