FileAPI - Revision history

TheKillerBunny: Follow style guide

2024-10-05T19:55:43Z

Follow style guide

← Older revision		Revision as of 19:55, 5 October 2024
Line 9:		Line 9:
	Every used path in methods is relative to data folder.		Every used path in methods is relative to data folder.

	== ~~FileAPI methods~~ ==		== Methods ==
			{\| class="wikitable"
			! Method
			! Brief Description
			\|-
			\| [[#allowed\|allowed]]
			\| Checks if FileAPI usage is allowed
			\|-
			\| [[#isPathAllowed\|isPathAllowed]]
			\| Checks if a path is allowed for usage
			\|-
			\| [[#exists\|exists]]
			\| Checks if a path exists
			\|-
			\| [[#delete\|delete]]
			\| Deletes a file or directory, returning whether it was successful
			\|-
			\| [[#isDirectory\|isDirectory]]
			\| Checks if a path is a directory
			\|-
			\| [[#mkdir\|mkdir]]
			\| Creates a directory
			\|-
			\| [[#mkdirs\|mkdirs]]
			\| Creates a directory and all parent directories
			\|-
			\| [[#list\|list]]
			\| Lists files and directories contained under a path
			\|-
			\| [[#isFile\|isFile]]
			\| Checks if a path is a file
			\|-
			\| [[#openReadStream\|openReadStream]]
			\| Opens an input stream for a file
			\|-
			\| [[#openWriteStream\|openWriteStream]]
			\| Opens an output stream for a file
			\|-
			\| [[#readString\|readString]]
			\| Reads a file and returns its contents as a string
			\|-
			\| [[#writeString\|writeString]]
			\| Writes a file's contents as a string
			\|}

	=== Security checks ===		=== Security checks ===
Line 19:		Line 62:
	Checks if FileAPI usage is allowed for this avatar.		Checks if FileAPI usage is allowed for this avatar.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments !! Return Type		! Arguments !! Return Type
Line 35:		Line 79:
	Checks if path is allowed for usage.		Checks if path is allowed for usage.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments !! Return Type		! Arguments !! Return Type
Line 61:		Line 106:
	Checks if specified path exists.		Checks if specified path exists.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments !! Return Type		! Arguments !! Return Type
Line 76:		Line 122:
	Deletes file or directory by specified path. Returns true if successful.		Deletes file or directory by specified path. Returns true if successful.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments !! Return Type		! Arguments !! Return Type
Line 102:		Line 149:
	Checks if specified path is directory.		Checks if specified path is directory.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments !! Return Type		! Arguments !! Return Type
Line 117:		Line 165:
	Creates directory by specified path. Returns true if successful.		Creates directory by specified path. Returns true if successful.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments !! Return Type		! Arguments !! Return Type
Line 136:		Line 185:
	Creates directory by specified path, and all parent directories if they doesn't exist. Returns true if successful.		Creates directory by specified path, and all parent directories if they doesn't exist. Returns true if successful.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments !! Return Type		! Arguments !! Return Type
Line 156:		Line 206:
	Lists files and directories by specified path. Returns table with paths, or null if path doesn't exist or not a directory.		Lists files and directories by specified path. Returns table with paths, or null if path doesn't exist or not a directory.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments !! Return Type		! Arguments !! Return Type
Line 179:		Line 230:
	Checks if specified path is a file.		Checks if specified path is a file.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments !! Return Type		! Arguments !! Return Type
Line 194:		Line 246:
	Open input stream for file at specified path. Throws an error if file doesn't exist.		Open input stream for file at specified path. Throws an error if file doesn't exist.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments !! Return Type		! Arguments !! Return Type
Line 216:		Line 269:
	Open output stream for file at specified path. Throws an error if unable to create a file.		Open output stream for file at specified path. Throws an error if unable to create a file.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments !! Return Type		! Arguments !! Return Type
Line 239:		Line 293:
	Default encoding is <code>utf8</code>.		Default encoding is <code>utf8</code>.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments !! Return Type		! Arguments !! Return Type
Line 258:		Line 313:
	Default encoding is <code>utf8</code>.		Default encoding is <code>utf8</code>.

			Overloads:
	{\| class="wikitable"		{\| class="wikitable"
	! Arguments		! Arguments

PenguinEncounter: /* list */ type v2

2024-09-28T23:35:08Z

list: type v2

← Older revision		Revision as of 23:35, 28 September 2024
Line 160:		Line 160:
	\|-		\|-
	\| <code>list(path {{type\|string}})</code>		\| <code>list(path {{type\|string}})</code>
	\| {{type\|string\|[]?}}		\| {{type\|string[]?}}
	\|}		\|}

Line 170:		Line 170:
	}]]		}]]
	</syntaxhighlight>		</syntaxhighlight>


	=== Files ===		=== Files ===

Joeyy: added navbox

2024-09-28T20:41:47Z

added navbox

← Older revision		Revision as of 20:41, 28 September 2024
Line 268:		Line 268:
	print(file:writeString("foo.bar", "Hello, world!"))		print(file:writeString("foo.bar", "Hello, world!"))
	</syntaxhighlight>		</syntaxhighlight>

			== Navigation ==
			{{Navbox documentation}}

Joeyy: /* FileAPI methods */ add hr

2024-09-28T19:53:03Z

FileAPI methods: add hr

← Older revision		Revision as of 19:53, 28 September 2024
Line 16:		Line 16:

	==== allowed ====		==== allowed ====
			----
	Checks if FileAPI usage is allowed for this avatar.		Checks if FileAPI usage is allowed for this avatar.

Line 32:		Line 32:

	==== isPathAllowed ====		==== isPathAllowed ====
			----
	Checks if path is allowed for usage.		Checks if path is allowed for usage.

Line 58:		Line 58:

	==== exists ====		==== exists ====
			----
	Checks if specified path exists.		Checks if specified path exists.

Line 73:		Line 73:

	==== delete ====		==== delete ====
			----
	Deletes file or directory by specified path. Returns true if successful.		Deletes file or directory by specified path. Returns true if successful.

Line 99:		Line 99:

	==== isDirectory ====		==== isDirectory ====
			----
	Checks if specified path is directory.		Checks if specified path is directory.

Line 114:		Line 114:

	==== mkdir ====		==== mkdir ====
			----
	Creates directory by specified path. Returns true if successful.		Creates directory by specified path. Returns true if successful.

Line 133:		Line 133:

	==== mkdirs ====		==== mkdirs ====
			----
	Creates directory by specified path, and all parent directories if they doesn't exist. Returns true if successful.		Creates directory by specified path, and all parent directories if they doesn't exist. Returns true if successful.

Line 153:		Line 153:

	==== list ====		==== list ====
			----
	Lists files and directories by specified path. Returns table with paths, or null if path doesn't exist or not a directory.		Lists files and directories by specified path. Returns table with paths, or null if path doesn't exist or not a directory.

Line 175:		Line 175:

	==== isFile ====		==== isFile ====
			----
	Checks if specified path is a file.		Checks if specified path is a file.

Line 190:		Line 190:

	==== openReadStream ====		==== openReadStream ====
			----
	Open input stream for file at specified path. Throws an error if file doesn't exist.		Open input stream for file at specified path. Throws an error if file doesn't exist.

Line 212:		Line 212:

	==== openWriteStream ====		==== openWriteStream ====
			----
	Open output stream for file at specified path. Throws an error if unable to create a file.		Open output stream for file at specified path. Throws an error if unable to create a file.

Line 234:		Line 234:

	==== readString ====		==== readString ====
			----
	Reads file at specified path and returns it's contents as a string in specified encoding.		Reads file at specified path and returns it's contents as a string in specified encoding.
	Default encoding is <code>utf8</code>.		Default encoding is <code>utf8</code>.
Line 253:		Line 253:

	==== writeString ====		==== writeString ====
			----
	Writes string in specified encoding to file by specified path.		Writes string in specified encoding to file by specified path.
	Default encoding is <code>utf8</code>.		Default encoding is <code>utf8</code>.

Lexize at 16:00, 28 September 2024

2024-09-28T16:00:03Z

← Older revision		Revision as of 16:00, 28 September 2024
Line 130:		Line 130:
	</syntaxhighlight>		</syntaxhighlight>

	'''@see''' [[~~FileAPI~~#exists\|exists]]		'''@see''' [[#exists\|exists]]

	==== mkdirs ====		==== mkdirs ====
Line 150:		Line 150:
	</syntaxhighlight>		</syntaxhighlight>

	'''@see''' [[~~FileAPI~~#exists\|exists]], [[~~FileAPI~~#mkdir\|mkdir]]		'''@see''' [[#exists\|exists]], [[#mkdir\|mkdir]]

	==== list ====		==== list ====

Lexize at 15:52, 28 September 2024

2024-09-28T15:52:56Z

← Older revision		Revision as of 15:52, 28 September 2024
Line 15:		Line 15:
	Security related methods of FileAPI.		Security related methods of FileAPI.

	==== ~~<code>FileAPI:~~allowed~~</code>~~ ====		==== allowed ====

	Checks if FileAPI usage is allowed for this avatar.		Checks if FileAPI usage is allowed for this avatar.
Line 31:		Line 31:
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~<code>FileAPI:~~isPathAllowed~~</code>~~ ====		==== isPathAllowed ====

	Checks if path is allowed for usage.		Checks if path is allowed for usage.
Line 57:		Line 57:
	Methods related both to files and directories.		Methods related both to files and directories.

	==== ~~<code>FileAPI:~~exists~~</code>~~ ====		==== exists ====

	Checks if specified path exists.		Checks if specified path exists.
Line 72:		Line 72:
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~<code>FileAPI:~~delete~~</code>~~ ====		==== delete ====

	Deletes file or directory by specified path. Returns true if successful.		Deletes file or directory by specified path. Returns true if successful.
Line 98:		Line 98:
	Directory related methods of FileAPI.		Directory related methods of FileAPI.

	==== ~~<code>FileAPI:~~isDirectory~~</code>~~ ====		==== isDirectory ====

	Checks if specified path is directory.		Checks if specified path is directory.
Line 113:		Line 113:
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~<code>FileAPI:~~mkdir~~</code>~~ ====		==== mkdir ====

	Creates directory by specified path. Returns true if successful.		Creates directory by specified path. Returns true if successful.
Line 132:		Line 132:
	'''@see''' [[FileAPI#exists\|exists]]		'''@see''' [[FileAPI#exists\|exists]]

	==== ~~<code>FileAPI:~~mkdirs~~</code>~~ ====		==== mkdirs ====

	Creates directory by specified path, and all parent directories if they doesn't exist. Returns true if successful.		Creates directory by specified path, and all parent directories if they doesn't exist. Returns true if successful.
Line 152:		Line 152:
	'''@see''' [[FileAPI#exists\|exists]], [[FileAPI#mkdir\|mkdir]]		'''@see''' [[FileAPI#exists\|exists]], [[FileAPI#mkdir\|mkdir]]

	==== ~~<code>FileAPI:~~list~~</code>~~ ====		==== list ====

	Lists files and directories by specified path. Returns table with paths, or null if path doesn't exist or not a directory.		Lists files and directories by specified path. Returns table with paths, or null if path doesn't exist or not a directory.
Line 174:		Line 174:
	Methods related to files.		Methods related to files.

	==== ~~<code>FileAPI:~~isFile~~</code>~~ ====		==== isFile ====

	Checks if specified path is a file.		Checks if specified path is a file.
Line 189:		Line 189:
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~<code>FileAPI:~~openReadStream~~</code>~~ ====		==== openReadStream ====

	Open input stream for file at specified path. Throws an error if file doesn't exist.		Open input stream for file at specified path. Throws an error if file doesn't exist.
Line 211:		Line 211:


	==== ~~<code>FileAPI:~~openWriteStream~~</code>~~ ====		==== openWriteStream ====

	Open output stream for file at specified path. Throws an error if unable to create a file.		Open output stream for file at specified path. Throws an error if unable to create a file.
Line 233:		Line 233:
	'''@see''' [[OutputStream#close\|OutputStream:close]]		'''@see''' [[OutputStream#close\|OutputStream:close]]

	==== ~~<code>FileAPI:~~readString~~</code>~~ ====		==== readString ====

	Reads file at specified path and returns it's contents as a string in specified encoding.		Reads file at specified path and returns it's contents as a string in specified encoding.
Line 252:		Line 252:
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~<code>FileAPI:~~writeString~~</code>~~ ====		==== writeString ====

	Writes string in specified encoding to file by specified path.		Writes string in specified encoding to file by specified path.

Lexize at 15:02, 28 September 2024

2024-09-28T15:02:21Z

← Older revision		Revision as of 15:02, 28 September 2024
Line 129:		Line 129:
	print(file:exists("foo")) -- true		print(file:exists("foo")) -- true
	</syntaxhighlight>		</syntaxhighlight>

			'''@see''' [[FileAPI#exists\|exists]]

	==== <code>FileAPI:mkdirs</code> ====		==== <code>FileAPI:mkdirs</code> ====
Line 147:		Line 149:
	print(file:exists("foo/bar")) -- true		print(file:exists("foo/bar")) -- true
	</syntaxhighlight>		</syntaxhighlight>

			'''@see''' [[FileAPI#exists\|exists]], [[FileAPI#mkdir\|mkdir]]

	==== <code>FileAPI:list</code> ====		==== <code>FileAPI:list</code> ====
Line 203:		Line 207:
	is:close()		is:close()
	</syntaxhighlight>		</syntaxhighlight>

			'''@see''' [[InputStream#close\|InputStream:close]]


Line 223:		Line 229:
	os:close()		os:close()
	</syntaxhighlight>		</syntaxhighlight>


			'''@see''' [[OutputStream#close\|OutputStream:close]]

	==== <code>FileAPI:readString</code> ====		==== <code>FileAPI:readString</code> ====

Lexize at 14:48, 28 September 2024

2024-09-28T14:48:26Z

← Older revision		Revision as of 14:48, 28 September 2024
Line 156:		Line 156:
	\|-		\|-
	\| <code>list(path {{type\|string}})</code>		\| <code>list(path {{type\|string}})</code>
	\| {{type\|string\|[]~~}}<nowiki>\|</nowiki>{{type\|nil~~}}		\| {{type\|string\|[]?}}
	\|}		\|}

Line 226:		Line 226:
	==== <code>FileAPI:readString</code> ====		==== <code>FileAPI:readString</code> ====

	Reads file at specified path and returns it's contents as a string.		Reads file at specified path and returns it's contents as a string in specified encoding.
			Default encoding is <code>utf8</code>.

	{\| class="wikitable"		{\| class="wikitable"
Line 234:		Line 235:
	\| {{type\|string}}		\| {{type\|string}}
	\|-		\|-
	\| <code>readString(path {{type\|string}}, encoding {{type\|~~string~~}})</code>		\| <code>readString(path {{type\|string}}, encoding {{type\|BufferEncoding}})</code>
	\| {{type\|string}}		\| {{type\|string}}
	\|}		\|}
Line 244:		Line 245:
	==== <code>FileAPI:writeString</code> ====		==== <code>FileAPI:writeString</code> ====

	Writes string in file by specified path.		Writes string in specified encoding to file by specified path.
			Default encoding is <code>utf8</code>.

	{\| class="wikitable"		{\| class="wikitable"
Line 251:		Line 253:
	\| <code>writeString(path {{type\|string}}, contents {{type\|string}})</code>		\| <code>writeString(path {{type\|string}}, contents {{type\|string}})</code>
	\|-		\|-
	\| <code>writeString(path {{type\|string}}, contents {{type\|string}}, encoding {{type\|~~string~~}})</code>		\| <code>writeString(path {{type\|string}}, contents {{type\|string}}, encoding {{type\|BufferEncoding}})</code>
	\|}		\|}

Lexize at 14:25, 28 September 2024

2024-09-28T14:25:20Z

← Older revision		Revision as of 14:25, 28 September 2024
Line 156:		Line 156:
	\|-		\|-
	\| <code>list(path {{type\|string}})</code>		\| <code>list(path {{type\|string}})</code>
	\| {{type\|string}}~~[]?~~		\| {{type\|string\|[]}}<nowiki>\|</nowiki>{{type\|nil}}
	\|}		\|}

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~local contents =~~ file:list("") --[[{		printTable(file:list("")) --[[{
	"foo.bar",		"foo.bar",
	"fooBar",		"fooBar",

Lexize: /* FileAPI:delete */

2024-09-28T14:16:07Z

FileAPI:delete

← Older revision		Revision as of 14:16, 28 September 2024
Line 84:		Line 84:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- Directory ~~foo~~ is empty		-- Directory fooBar is empty
	print(file:delete("fooBar")) -- true		print(file:delete("fooBar")) -- true
	-- Directory ~~bar~~ has files inside		-- Directory barFoo has files inside
	print(file:delete("barFoo")) -- false		print(file:delete("barFoo")) -- false
	-- foo.bar is not open by any program		-- foo.bar is not open by any program
	print(file:delete("foo.bar")) -- true		print(file:delete("foo.bar")) -- true
	-- bar.foo ~~is open by some program~~		-- bar.foo doesn't exist
	print(file:delete("bar.foo")) -- false		print(file:delete("bar.foo")) -- false
	</syntaxhighlight>		</syntaxhighlight>