Module app_dirs

Source

Structs§

OwnedAppInfo
A version of AppInfo that owns it’s strings The author property is currently only used by Windows, as macOS and *nix specifications don’t require it. Make sure your name string is unique!
StaticAppInfo
Struct that holds information about your app.

Enums§

AppDataType
Enum specifying the type of app data you want to store.
AppDirsError
Error type for any app_dirs operation.

Traits§

AppMeta
Implement this trait for object that will be passed to app_dir, get_app_dir, app_root, get_app_root functions The author property is currently only used by Windows, as macOS and *nix specifications don’t require it. Make sure your name string is unique!

Functions§

app_dir
Creates (if necessary) and returns path to app-specific data subdirectory for provided data type and subdirectory path.
app_root
Creates (if necessary) and returns path to app-specific data directory for provided data type.
data_root
Creates (if necessary) and returns path to top-level data directory for provided data type.
get_app_dir
Returns (but does not create) path to app-specific data subdirectory for provided data type and subdirectory path.
get_app_root
Returns (but does not create) path to app-specific data directory for provided data type.
get_data_root
Returns (but does not create) path to top-level data directory for provided data type.
sanitized
Returns a cross-platform-filename-safe version of any string.

Type Aliases§

AppInfoDeprecated
Old name for StaticAppInfo. AppInfo is deprecated.