Module tauri_sys::path

The path module provides utilities for working with file and directory paths.

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

{
    "tauri": {
        "allowlist": {
            "path": {
                "all": true, // enable all Path APIs
            }
        }
    }
}

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

Functions

• app_cache_dir
  Returns the path to the suggested directory for your app’s cache files.
• app_config_dir
  Returns the path to the suggested directory for your app’s config files.
• app_data_dir
  Returns the path to the suggested directory for your app’s data files.
• app_local_data_dir
  Returns the path to the suggested directory for your app’s local data files.
• app_log_dir
  Returns the path to the suggested directory for your app’s log files.
• audio_dir
  Returns the path to the user’s audio directory.
• basename
  Returns the last portion of a path. Trailing directory separators are ignored.
• cache_dir
  Returns the path to the user’s cache directory.
• config_dir
  Returns the path to the user’s config directory.
• data_dir
  Returns the path to the user’s data directory.
• desktop_dir
  Returns the path to the user’s desktop directory.
• dirname
  Returns the directory name of a path. Trailing directory separators are ignored.
• document_dir
  Returns the path to the user’s document directory.
• download_dir
  Returns the path to the user’s download directory.
• executable_dir
  Returns the path to the user’s executable directory.
• extname
  Returns the extension of the path.
• font_dir
  Returns the path to the user’s font directory.
• home_dir
  Returns the path to the user’s home directory.
• is_absolute
  Returns whether the path is absolute or not.
• join
  Joins all given path segments together using the platform-specific separator as a delimiter, then normalizes the resulting path.
• local_data_dir
  Returns the path to the user’s local data directory.
• normalize
  Normalizes the given path, resolving '..' and '.' segments and resolve symbolic links.
• picture_dir
  Returns the path to the user’s picture directory.
• public_dir
  Returns the path to the user’s public directory.
• resolve
  Resolves a sequence of paths or path segments into an absolute path.
• resolve_resource
  Resolve the path to a resource file.
• resource_dir
  Returns the path to the application’s resource directory.
• runtime_dir
  Returns the path to the user’s runtime directory.
• template_dir
  Returns the path to the user’s template directory.
• video_dir
  Returns the path to the user’s video directory.