# Filesystem

## Functions

### read

```lua
fs.read("some_file.txt")
```

|                                                                             |                                                                            |                                                                               |
| :-------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :---------------------------------------------------------------------------: |
| [Parameter](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) | [Description](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                                     path                                    |                                   string                                   |                                  path to file                                 |

#### Returns:

|                                                                         |                                                                            |
| :---------------------------------------------------------------------: | :------------------------------------------------------------------------: |
| [Value](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                                   data                                  |                                   string                                   |

### read\_stream

```lua
fs.read_stream("some_file.txt")
```

|                                                                             |                                                                            |                                                                               |
| :-------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :---------------------------------------------------------------------------: |
| [Parameter](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) | [Description](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                                     path                                    |                                   string                                   |                                  path to file                                 |

#### Returns:

|                                                                         |                                                                            |
| :---------------------------------------------------------------------: | :------------------------------------------------------------------------: |
| [Value](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                                   data                                  |                                table of char                               |

### write

```lua
fs.write("some_file.txt", "data")
```

|                                                                             |                                                                            |                                                                               |
| :-------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :---------------------------------------------------------------------------: |
| [Parameter](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) | [Description](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                                     path                                    |                                   string                                   |                                  path to file                                 |
|                                     data                                    |                                   string                                   |                             data to write to file                             |

### write\_stream

```lua
fs.write_stream("some_file.txt", {"a", "b", "c"})
```

|                                                                             |                                                                            |                                                                               |
| :-------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :---------------------------------------------------------------------------: |
| [Parameter](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) | [Description](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                                     path                                    |                                   string                                   |                                  path to file                                 |
|                                     data                                    |                                table of char                               |                         data in bytes to write to file                        |

### remove

```lua
fs.remove("some_file.txt")
```

|                                                                             |                                                                            |                                                                               |
| :-------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :---------------------------------------------------------------------------: |
| [Parameter](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) | [Description](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                                     path                                    |                                   string                                   |                                  path to file                                 |

### exists

```lua
fs.exists("some_file.txt")
```

|                                                                             |                                                                            |                                                                               |
| :-------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :---------------------------------------------------------------------------: |
| [Parameter](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) | [Description](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                                     path                                    |                                   string                                   |                           path to file or directory                           |

#### Returns:

|                                                                         |                                                                            |
| :---------------------------------------------------------------------: | :------------------------------------------------------------------------: |
| [Value](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                           true if file exists                           |                                   boolean                                  |

### is\_file

```lua
fs.is_file("some_file.txt")
```

|                                                                             |                                                                            |                                                                               |
| :-------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :---------------------------------------------------------------------------: |
| [Parameter](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) | [Description](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                                     path                                    |                                   string                                   |                                  path to file                                 |

#### Returns:

|                                                                         |                                                                            |
| :---------------------------------------------------------------------: | :------------------------------------------------------------------------: |
| [Value](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                       true if path leads to a file                      |                                   boolean                                  |

### is\_dir

```lua
fs.is_dir("some_file.txt")
```

|                                                                             |                                                                            |                                                                               |
| :-------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :---------------------------------------------------------------------------: |
| [Parameter](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) | [Description](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                                     path                                    |                                   string                                   |                               path to directory                               |

#### Returns:

|                                                                         |                                                                            |
| :---------------------------------------------------------------------: | :------------------------------------------------------------------------: |
| [Value](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                    true if path leads to a directory                    |                                   boolean                                  |

### create\_dir

```lua
fs.create_dir("folder/some_directory")
```

|                                                                             |                                                                            |                                                                               |
| :-------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :---------------------------------------------------------------------------: |
| [Parameter](https://golua.fatality.win/documentation/namespaces/filesystem) | [Datatype](https://golua.fatality.win/documentation/namespaces/filesystem) | [Description](https://golua.fatality.win/documentation/namespaces/filesystem) |
|                                     path                                    |                                   string                                   |                               path to directory                               |