imported>OCDoc Import: Imported from legacy OpenComputers documentation at ocdoc.cil.li

2026-08-24T08:08:27Z

Imported from legacy OpenComputers documentation at ocdoc.cil.li

New page

= Component: Filesystem =

This component is provided by [[Item/floppy disk|Floppy Disks]] or [[Item/hard disk drive|Hard Disk Drives]] in Managed mode (for Unmanaged mode, see [[Component/drive|Drive]])

Component name: `filesystem`. Callbacks:

* `spaceUsed():number`

<pre>The currently used capacity of the file system, in bytes.
</pre>
* `open(path:string[, mode:string='r']):number`

<pre>Opens a new file descriptor and returns its handle.
</pre>
* `seek(handle:number, whence:string, offset:number):number`

<pre>Seeks in an open file descriptor with the specified handle. Returns the new pointer position.
</pre>
* `makeDirectory(path:string):boolean`

<pre>Creates a directory at the specified absolute path in the file system. Creates parent directories, if necessary.
</pre>
* `exists(path:string):boolean`

<pre>Returns whether an object exists at the specified absolute path in the file system.
</pre>
* `isReadOnly():boolean`

<pre>Returns whether the file system is read-only.
</pre>
* `write(handle:number, value:string):boolean`

<pre>Writes the specified data to an open file descriptor with the specified handle.
</pre>
* `spaceTotal():number`

<pre>The overall capacity of the file system, in bytes.
</pre>
* `isDirectory(path:string):boolean`

<pre>Returns whether the object at the specified absolute path in the file system is a directory.
</pre>
* `rename(from:string, to:string):boolean`

<pre>Renames/moves an object from the first specified absolute path in the file system to the second.
</pre>
* `list(path:string):table`

<pre>Returns a list of names of objects in the directory at the specified absolute path in the file system.
</pre>
* `lastModified(path:string):number`

<pre>Returns the (real world) timestamp of when the object at the specified absolute path in the file system was modified.
</pre>
* `getLabel():string`

<pre>Get the current label of the file system.
</pre>
* `remove(path:string):boolean`

<pre>Removes the object at the specified absolute path in the file system.
</pre>
* `close(handle:number)`

<pre>Closes an open file descriptor with the specified handle.
</pre>
* `size(path:string):number`

<pre>Returns the size of the object at the specified absolute path in the file system.
</pre>
* `read(handle:number, count:number):string or nil`

<pre>Reads up to the specified amount of data from an open file descriptor with the specified handle. Returns nil when EOF is reached.
</pre>
* `setLabel(value:string):string`

<pre>Sets the label of the file system. Returns the new value, which may be truncated.
</pre>

-----

{{:Component/contents}}

Component/filesystem - Revision history

imported>OCDoc Import: Imported from legacy OpenComputers documentation at ocdoc.cil.li