Modules/FileSystem/object/destroy - Revision history

Quiret at 23:04, 19 January 2022

2022-01-19T23:04:42Z

← Older revision		Revision as of 23:04, 19 January 2022
Line 17:		Line 17:
	-- TODO.		-- TODO.
	</syntaxhighlight>		</syntaxhighlight>
			{{:Modules/FileSystem/object/functions}}

	{{:Modules/FileSystem/translator/functions}}		{{:Modules/FileSystem/translator/functions}}

	{{:Modules/FileSystem/file/functions}}		{{:Modules/FileSystem/file/functions}}

Quiret at 23:03, 19 January 2022

2022-01-19T23:03:49Z

← Older revision		Revision as of 23:03, 19 January 2022
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	This function destroys the underlying object passed to it, rendering all Lua references to it null and void. All OS handles that ~~have~~ been associated with it are released.		This function destroys the underlying object passed to it, rendering all Lua references to it null and void. All OS handles that had been associated with it are released.

	==Syntax==		==Syntax==

Quiret: /* Remarks */

2022-01-19T23:03:16Z

Remarks

← Older revision		Revision as of 23:03, 19 January 2022
Line 11:		Line 11:

	==Remarks==		==Remarks==
	It is a good idea to call this function on all files or translators whose use has expired. This way the release of OS resources is ~~guarranteed~~ to happen at a predictable point in time. Since all Eir FileSystem objects are '''garbage collected by default''' it is strictly-speaking not a must, but a strong recommendation. Adhering to this recommendation is a strong guideline for clean programming practice.		It is a good idea to call this function on all files or translators whose use has expired. This way the release of OS resources is guaranteed to happen at a predictable point in time. Since all Eir FileSystem objects are '''garbage collected by default''' it is strictly-speaking not a must, but a strong recommendation. Adhering to this recommendation is a strong guideline for clean programming practice.

	==Example==		==Example==

Quiret: Created page with "NOTOC This function destroys the underlying object passed to it, rendering all Lua references to it null and void. All OS handles that have been associated with it are released. ==Syntax== nil fsobject:destroy () ==Returns== This function returns nil. ==Remarks== It is a good idea to call this function on all files or translators whose use has expired. This way the release of OS resources is guarranteed to happen at..."

2022-01-19T23:02:38Z

Created page with "__NOTOC__ This function destroys the underlying object passed to it, rendering all Lua references to it null and void. All OS handles that have been associated with it are released. ==Syntax== <syntaxhighlight lang="lua"> nil fsobject:destroy () </syntaxhighlight> ==Returns== This function returns nil. ==Remarks== It is a good idea to call this function on all files or translators whose use has expired. This way the release of OS resources is guarranteed to happen at..."

New page

__NOTOC__
This function destroys the underlying object passed to it, rendering all Lua references to it null and void. All OS handles that have been associated with it are released.

==Syntax==
<syntaxhighlight lang="lua">
nil fsobject:destroy ()
</syntaxhighlight>

==Returns==
This function returns nil.

==Remarks==
It is a good idea to call this function on all files or translators whose use has expired. This way the release of OS resources is guarranteed to happen at a predictable point in time. Since all Eir FileSystem objects are '''garbage collected by default''' it is strictly-speaking not a must, but a strong recommendation. Adhering to this recommendation is a strong guideline for clean programming practice.

==Example==
<syntaxhighlight lang="lua">
-- TODO.
</syntaxhighlight>
{{:Modules/FileSystem/translator/functions}}

{{:Modules/FileSystem/file/functions}}