Module tauri_sys::fs

Access the file system.

The APIs must be added to tauri.allowlist.fs in tauri.conf.json:

{
  "tauri": {
    "allowlist": {
      "fs": {
        "all": true, // enable all FS APIs
        "readFile": true,
        "writeFile": true,
        "readDir": true,
        "copyFile": true,
        "createDir": true,
        "removeDir": true,
        "removeFile": true,
        "renameFile": true,
        "exists": true
      }
    }
  }
}

It is recommended to allowlist only the APIs you use for optimal bundle size and security.

Structs

• FileEntry

Enums

• BaseDirectory

Functions

• copy_file
  Copies a file to a destination.
• create_dir
  Creates a directory. If one of the path’s parent components doesn’t exist the promise will be rejected.
• create_dir_all
  Creates a directory recursively.
• exists
  Checks if a path exists.
• read_binary_file
  Reads a file as a byte array.
• read_dir
  List directory files.
• read_dir_all
  List directory files recursively.
• read_text_file
  Read a file as an UTF-8 encoded string.
• remove_dir
  Removes a directory. If the directory is not empty the promise will be rejected.
• remove_dir_all
  Removes a directory and its contents.
• remove_file
  Removes a file.
• rename_file
  Renames a file.
• write_binary_file
  Writes a byte array content to a file.
• write_text_file
  Writes a UTF-8 text file.