std::formatter<std::filesystem::path>

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

檔案系統庫

類
filesystem::path filesystem::filesystem_error filesystem::directory_entry filesystem::directory_iterator filesystem::recursive_directory_iterator    filesystem::file_status filesystem::space_info	filesystem::file_type filesystem::file_time_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options
函式
filesystem::absolute filesystem::canonicalfilesystem::weakly_canonical filesystem::relativefilesystem::proximate filesystem::copy filesystem::copy_file filesystem::copy_symlink filesystem::create_directory filesystem::create_directories filesystem::create_hard_link filesystem::create_symlink filesystem::create_directory_symlink filesystem::current_path filesystem::temp_directory_path	filesystem::exists filesystem::equivalent filesystem::file_size filesystem::hard_link_count filesystem::last_write_time filesystem::permissions filesystem::read_symlink filesystem::remove filesystem::remove_all filesystem::rename filesystem::resize_file filesystem::space filesystem::status filesystem::symlink_status
檔案型別
filesystem::is_block_file filesystem::is_character_file filesystem::is_directory filesystem::is_empty filesystem::status_known	filesystem::is_fifo filesystem::is_other filesystem::is_regular_file filesystem::is_socket filesystem::is_symlink

 

std::filesystem::path

成員型別
成員常量
path::native_formatpath::generic_formatpath::auto_format
成員函式
path::path path::~path path::operator= path::assign path::appendpath::operator/= path::concatpath::operator+= path::clear path::make_preferred path::remove_filename path::replace_filename path::replace_extension    path::swap path::compare path::beginpath::end	path::c_strpath::nativepath::operator string_type path::stringpath::u8stringpath::u16stringpath::u32stringpath::wstring path::generic_stringpath::generic_u8stringpath::generic_u16stringpath::generic_u32stringpath::generic_wstring path::lexically_normalpath::lexically_relativepath::lexically_proximate
路徑分解
path::root_name path::root_directory path::root_path path::relative_path path::parent_path path::filename path::stem path::extension path::empty	path::has_root_pathpath::has_root_namepath::has_root_directorypath::has_relative_pathpath::has_parent_pathpath::has_filenamepath::has_stempath::has_extension path::is_absolutepath::is_relative
非成員函式
operator==operator!=operator<operator<=operator>operator>=operator<=> (C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20 前)(C++20)	operator/ operator<<operator>> swap(std::filesystem::path) hash_value u8path
輔助類
hash<std::filesystem::path>	formatter<std::filesystem::path> (C++26)

 

定義於標頭檔案 <filesystem>
template< class CharT > struct formatter<std::filesystem::path, CharT>;		(C++26 起)

對 std::filesystem::path 類的 std::formatter 模板特化允許使用者使用格式化函式將路徑名轉換為其文字表示。此特化是啟用除錯 (debug-enabled) 的。

格式規定

格式規定 path-format-spec 的語法是

填充與對齊(可選) 寬度(可選) ?(可選) g(可選)

填充與對齊 和 寬度 的含義與標準格式規定中的相同。

? 選項用於將路徑名格式化為跳脫字元串。

g 選項用於指定路徑名使用通用格式表示。

成員函式

set_debug_format	啟用將路徑名格式化為跳脫字元串 (公開成員函式)
parse	按照 path-format-spec 解析格式說明符 (公開成員函式)
format	按照 path-format-spec 寫入格式化的輸出 (公開成員函式)

std::formatter<std::filesystem::path>::set_debug_format

constexpr void set_debug_format();

允許當前物件將路徑名格式化為跳脫字元串。

std::formatter<std::filesystem::path>::parse

constexpr auto parse( std::basic_format_parse_context<CharT>& ctx )     -> std::basic_format_parse_context<CharT>::iterator;

將格式說明符解析為 path-format-spec 並將解析後的說明符儲存在當前物件中。

返回一個指向 path-format-spec 結尾之後位置的迭代器。

std::formatter<std::filesystem::path>::format

template< class FormatContext > auto format( const std::filesystem::path& p, FormatContext& ctx ) const     -> FormatContext::iterator;

令 s 為 p.generic<std::filesystem::path::value_type>()（如果使用了 g 選項），否則為 p.native()。按照 path-format-spec 的規定，將 s 寫入 ctx.out()。

關於路徑名的字元轉碼：

• 如果滿足以下條件，路徑名會從寬字元字串的原生編碼轉碼為 UTF-8，其中格式錯誤的子序列的最大子部分將被替換為 U+FFFD REPLACEMENT CHARACTER：
  • std::is_same_v<CharT, char> 為 true，
  • std::is_same_v<typename path::value_type, wchar_t> 為 true，且
  • 普通字面量編碼是 UTF-8。
• 否則，如果 std::is_same_v<typename path::value_type, CharT> 為 true，則不執行轉碼。
• 否則，轉碼行為是實現定義的。

返回一個迭代器，指向輸出範圍的末尾之後。

注意

特性測試宏	值	標準	特性
__cpp_lib_format_path	202403L	(C++26)	對 std::filesystem::path 的格式化支援

參見

formatter (C++20)

定義給定型別的格式化規則 (類模板)