platformdirs.h File Reference

#include "platformdirs/api.h"
#include "platformdirs/version.h"
#include <filesystem>
#include <string>
#include <string_view>
#include <variant>
#include "platformdirs/unix.h"

Go to the source code of this file.

Namespaces
namespace	platformdirs

Typedefs
using	platformdirs::platform_dirs
using	platformdirs::app_dirs = platform_dirs
using	platformdirs::platform_dirs_abc = platformdirs::api::platform_dirs_abc

Functions
std::string	platformdirs::user_data_dir (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool ensure_exists=false)
std::string	platformdirs::site_data_dir (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool multipath=false, bool ensure_exists=false)
std::string	platformdirs::user_config_dir (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool ensure_exists=false)
std::string	platformdirs::site_config_dir (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool multipath=false, bool ensure_exists=false)
std::string	platformdirs::user_cache_dir (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool ensure_exists=false)
std::string	platformdirs::site_cache_dir (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool multipath=false, bool ensure_exists=false)
std::string	platformdirs::user_state_dir (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool ensure_exists=false)
std::string	platformdirs::user_log_dir (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool ensure_exists=false)
std::string	platformdirs::user_documents_dir ()
std::string	platformdirs::user_downloads_dir ()
std::string	platformdirs::user_pictures_dir ()
std::string	platformdirs::user_videos_dir ()
std::string	platformdirs::user_music_dir ()
std::string	platformdirs::user_desktop_dir ()
std::string	platformdirs::user_runtime_dir (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool ensure_exists=false)
std::string	platformdirs::site_runtime_dir (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool multipath=false, bool ensure_exists=false)
std::filesystem::path	platformdirs::user_data_path (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool ensure_exists=false)
std::filesystem::path	platformdirs::site_data_path (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool multipath=false, bool ensure_exists=false)
std::filesystem::path	platformdirs::user_config_path (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool ensure_exists=false)
std::filesystem::path	platformdirs::site_config_path (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool multipath=false, bool ensure_exists=false)
std::filesystem::path	platformdirs::user_cache_path (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool ensure_exists=false)
std::filesystem::path	platformdirs::site_cache_path (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool multipath=false, bool ensure_exists=false)
std::filesystem::path	platformdirs::user_state_path (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool ensure_exists=false)
std::filesystem::path	platformdirs::user_log_path (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool ensure_exists=false)
std::filesystem::path	platformdirs::user_documents_path ()
std::filesystem::path	platformdirs::user_downloads_path ()
std::filesystem::path	platformdirs::user_pictures_path ()
std::filesystem::path	platformdirs::user_videos_path ()
std::filesystem::path	platformdirs::user_music_path ()
std::filesystem::path	platformdirs::user_desktop_path ()
std::filesystem::path	platformdirs::user_runtime_path (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool ensure_exists=false)
std::filesystem::path	platformdirs::site_runtime_path (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool multipath=false, bool ensure_exists=false)

Variables
constexpr auto &	platformdirs::version_ = platformdirs::version::version
constexpr auto &	platformdirs::version_info = platformdirs::version::version_tuple