Fs (API) - Revision history

Bomb Bloke: fs.complete()

2015-07-05T07:20:27Z

fs.complete()

MKlegoman357 at 21:35, 16 April 2014

2014-04-16T21:35:32Z

MKlegoman357: Added fs.getDir()

2014-04-16T21:25:52Z

Added fs.getDir()

Oeed: Added fs.find

2014-03-28T07:28:47Z

Added fs.find

Oeed: Added NeedsWork note

2014-03-28T06:01:42Z

Added NeedsWork note

Chainmanner at 17:33, 14 November 2013

2013-11-14T17:33:58Z

Immibis: use template for API table.

2013-08-25T03:39:02Z

use template for API table.

Cranium: Changing int to number

2013-07-18T10:47:30Z

Changing int to number

TheCoryKid: Fixed table row background colors and adjusted column widths.

2013-05-05T13:57:39Z

Fixed table row background colors and adjusted column widths.

Hawk777: Copy descriptions from function pages, add return column, and use type template

2013-04-22T19:43:38Z

Copy descriptions from function pages, add return column, and use type template

@@ Line 89: / Line 89: @@
 |{{Type|string}} parentDirectory
 |Returns the parent directory of <var>path</var>. '''''Requires version 1.63 or later.'''''}}
 }}
@@ Line 95: / Line 101: @@
 ==Path Names==
 All of these functions except for [[fs.combine]] refer solely to <em>absolute paths</em>.<br />
-This means that the current working directory, as set by the <code>cd</code> command or the [[shell.setDir]] function, is ignored. Each path name consists of a list of nonempty path components separated by forward slashes, and those path components are taken one by one with the first being contained in the root directory of the computer.
+This means that the current working directory, as set by the <code>cd</code> command or the [[shell.setDir]] function, is ignored. Each path name consists of a list of non-empty path components separated by forward slashes, and those path components are taken one by one with the first being contained in the root directory of the computer.
 If you need to deal with paths provided by the user that may be absolute or may be relative to the current working directory, use [[shell.resolve]].
 Unlike most real-world operating systems, ComputerCraft's absolute path name system does not need to be started with a forward slash ( / ), making the directory "a/b/c" the same as "/a/b/c". Leaving the slashes is just a matter of preference to the coder.

@@ Line 82: / Line 82: @@
 {{API table/row|[[fs.find]]({{Type|string}} wildcard)
 |{{type|table}} files
-|Searches the computer's files using [https://twitter.com/DanTwoHundred/status/417113682129068032 wildcards]. ''Requires version 1.6 or later.''
+|Searches the computer's files using [https://twitter.com/DanTwoHundred/status/417113682129068032 wildcards]. '''''Requires version 1.6 or later.'''''
 |odd}}
@@ Line 88: / Line 88: @@
 |[[fs.getDir]]({{Type|string}} path)
 |{{Type|string}} parentDirectory
-|Returns the parent directory of <var>path</var>.}}
+|Returns the parent directory of <var>path</var>. '''''Requires version 1.63 or later.'''''}}
-−
 }}

@@ Line 1: / Line 1: @@
 The FS API allows you to manipulate files and the filesystem.
-{{API table|FS|image=Grid_disk.png|2=
+{{API table|fs|image=Grid_disk.png|2=
-{{API table/row|[[fs.list]]({{Type|string}} path)|{{type|table}} files|Returns a list of all the files (including subdirectories but not their contents) contained in a directory, as a numerically indexed table.|odd}}
+{{API table/row
-{{API table/row|[[fs.exists]]({{Type|string}} path)|{{Type|boolean}} exists|Checks if a path refers to an existing file or directory.|}}
+{{API table/row
-{{API table/row|[[fs.isDir]]({{Type|string}} path)|{{Type|boolean}} isdir|Checks if a path refers to an existing directory.|odd}}
+|[[fs.exists]]({{Type|string}} path)
-{{API table/row|[[fs.isReadOnly]]({{Type|string}} path)|{{Type|boolean}} readonly|Checks if a path is read-only (i.e. cannot be modified).|}}
+|{{Type|boolean}} exists
-{{API table/row|[[fs.getName]]({{type|string}} path)|{{type|string}} name|Gets the final component of a pathname.|odd}}
+|Checks if a path refers to an existing file or directory.}}
-{{API table/row|[[fs.getDrive]]({{type|string}} path)|{{type|string}}/{{type|nil}} drive|Gets the storage medium holding a path, or [[nil]] if the path does not exist.|}}
-{{API table/row|[[fs.getSize]]({{Type|string}} path)|{{type|number}} size|Gets the size of a file in bytes.|odd}}
+{{API table/row
-{{API table/row|[[fs.getFreeSpace]]({{Type|string}} path)|{{type|number}} space|Gets the remaining space on the drive containing the given directory.|}}
+|[[fs.isDir]]({{Type|string}} path)
-{{API table/row|[[fs.makeDir]]({{Type|string}} path)|{{type|nil}}|Makes a directory.|odd}}
+|{{Type|boolean}} isDirectory
-{{API table/row|[[fs.move]]({{Type|string}} fromPath, {{Type|string}} toPath)|{{type|nil}}|Moves a file or directory to a new location.|}}
+|Checks if a path refers to an existing directory.
-{{API table/row|[[fs.copy]]({{Type|string}} fromPath, {{Type|string}} toPath)|{{type|nil}}|Copies a file or directory to a new location.|odd}}
+|odd}}
-{{API table/row|[[fs.delete]]({{Type|string}} path)|{{type|nil}}|Deletes a file or directory.|}}
-{{API table/row|[[fs.combine]]({{Type|string}} basePath, {{Type|string}} localPath)|{{type|string}} path|Combines two path components, returning a path consisting of the local path nested inside the base path.|odd}}
+{{API table/row
-{{API table/row|[[fs.open]]({{Type|string}} path, {{Type|string}} mode)|{{type|table}} handle|Opens a file so it can be read or written.|}}
+|[[fs.isReadOnly]]({{Type|string}} path)
-{{API table/row|[[fs.find]]({{Type|string}} wildcard)|{{type|table}} files|Searches the computer's files using [https://twitter.com/DanTwoHundred/status/417113682129068032 wildcards]. ''Requires version 1.6 or later.''|}}
+|{{Type|boolean}} readonly
 }}

@@ Line 1: / Line 1: @@
 The FS API allows you to manipulate files and the filesystem.
@@ Line 20: / Line 18: @@
 {{API table/row|[[fs.combine]]({{Type|string}} basePath, {{Type|string}} localPath)|{{type|string}} path|Combines two path components, returning a path consisting of the local path nested inside the base path.|odd}}
 {{API table/row|[[fs.open]]({{Type|string}} path, {{Type|string}} mode)|{{type|table}} handle|Opens a file so it can be read or written.|}}
 }}

← Older revision		Revision as of 06:01, 28 March 2014
Line 1:		Line 1:
		+	{{NeedsWork\|New 1.6 functions and changes should be added. - [[User:Oeed\|Oeed]] 06:01, 28 March 2014 (GMT)}}
		+
	The FS API allows you to manipulate files and the filesystem.		The FS API allows you to manipulate files and the filesystem.

← Older revision		Revision as of 17:33, 14 November 2013
Line 1:		Line 1:
−	The FS API allows you to ~~mess around with~~ the filesystem.	+	The FS API allows you to manipulate files and the filesystem.

	{{API table\|FS\|image=Grid_disk.png\|2=		{{API table\|FS\|image=Grid_disk.png\|2=

@@ Line 1: / Line 1: @@
 The FS API allows you to mess around with the filesystem.
-<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
+{{API table/row|[[fs.list]]({{Type|string}} path)|{{type|table}} files|Returns a list of all the files (including subdirectories but not their contents) contained in a directory, as a numerically indexed table.|odd}}
-<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
-[[File:Grid_disk.png|24px]]&nbsp;&nbsp;
-Fs (API)
-</td></tr>
-<tr><td style="width: 130px; background: #E0E0E0; padding: .4em; font-weight:bold;">Return</td><td style="width: 300px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
+{{API table/row|[[fs.exists]]({{Type|string}} path)|{{Type|boolean}} exists|Checks if a path refers to an existing file or directory.|}}
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|table}} files</td>
+}}
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.list]]({{Type|string}} path)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a list of all the files (including subdirectories but not their contents) contained in a directory, as a numerically indexed table.</td></tr>
-−
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|boolean}} exists</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.exists]]({{Type|string}} path)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks if a path refers to an existing file or directory.</td></tr>
-−
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|boolean}} dir</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.isDir]]({{Type|string}} path)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks if a path refers to an existing directory.</td></tr>
-−
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|boolean}} readOnly</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.isReadOnly]]({{Type|string}} path)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks if a path is read-only (i.e. cannot be modified).</td></tr>
-−
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|string}} name</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getName]]({{Type|string}} path)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gets the final component of a pathname.</td></tr>
-−
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|string}} drive, or [[nil]]</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getDrive]]({{Type|string}} path)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the storage medium holding a path, or [[nil]] if the path does not exist.</td></tr>
-−
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|number}} size</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getSize]]({{Type|string}} path)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gets the size of a file in bytes</td></tr>
-−
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|number}} space</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getFreeSpace]]({{Type|string}} path)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gets the remaining space in the given directory.</td></tr>
-−
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.makeDir]]({{Type|string}} path)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Makes a directory.</td></tr>
-−
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.move]]({{Type|string}} fromPath, {{Type|string}} toPath)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Moves a file or directory to a new location.</td></tr>
-−
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.copy]]({{Type|string}} fromPath, {{Type|string}} toPath)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Copies a file or directory to a new location.</td></tr>
-−
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.delete]]({{Type|string}} path)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Deletes a file or directory.</td></tr>
-−
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|string}} path</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.combine]]({{Type|string}} basePath, {{Type|string}} localPath)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Combines two path components, returning a path consisting of the local path nested inside the base path.</td></tr>
-−
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|table}} handle</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.open]]({{Type|string}} path, {{Type|string}} mode)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Opens a file so it can be read or written.</td></tr>
-</table>
 [[Category:APIs]]

@@ Line 3: / Line 3: @@
 <table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
-<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
+<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
 [[File:Grid_disk.png|24px]]&nbsp;&nbsp;
 Fs (API)
 </td></tr>
-<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
+<tr><td style="width: 100px; background: #E0E0E0; padding: .4em; font-weight:bold;">Return</td><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.list]](path)</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|table}} files</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Lists the directories and files in the given directory</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.list]]({{Type|string}} path)</td>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.exists]](path)</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|boolean}} exists</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks if a path refers to an existing file or directory</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.exists]]({{Type|string}} path)</td>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.isDir]](path)</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|boolean}} dir</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks if a path refers to an existing directory</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.isDir]]({{Type|string}} path)</td>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.isReadOnly]](path)</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|boolean}} readOnly</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks if a path is read-only (i.e. cannot be modified)</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.isReadOnly]]({{Type|string}} path)</td>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getName]](path)</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|string}} name</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gets the final component of a pathname</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getName]]({{Type|string}} path)</td>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getDrive]](path)</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|string}} drive, or [[nil]]</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gets the type of storage medium holding a file or directory</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getDrive]]({{Type|string}} path)</td>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getSize]](path)</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|int}} size</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gets the size of a file and returns in bytes</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getSize]]({{Type|string}} path)</td>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getFreeSpace]](path)</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|int}} space</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gets the remaining space in the given directory.</td></tr>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.makeDir]](path)</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Makes a directory</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.makeDir]]({{Type|string}} path)</td>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.move]](fromPath, toPath)</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Moves a file or directory to a new location</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.move]]({{Type|string}} fromPath, {{Type|string}} toPath)</td>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.copy]](fromPath, toPath)</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Copies a file or directory to a new location</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.copy]]({{Type|string}} fromPath, {{Type|string}} toPath)</td>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.delete]](path)</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Deletes a file or directory</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.delete]]({{Type|string}} path)</td>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.combine]](basePath, localPath)</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|string}} path</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Combines two path components, returning a path consisting of the local path nested inside the base path</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.combine]]({{Type|string}} basePath, {{Type|string}} localPath)</td>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.open]](path, mode)</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|table}} handle</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Opens a file so it can be read or written</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.open]]({{Type|string}} path, {{Type|string}} mode)</td>
 </table>