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

 

C++

编译器支持

独立式和宿主式

语言

标准库

标准库头文件

具名要求

特性测试宏 (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::formatter 的模板特化，用于 std::filesystem::path 类，允许用户使用格式化函数将其路径名转换为文本表示形式。此特化是debug-enabled。

格式规范

格式规范 path-format-spec 的语法是

fill-and-align (可选) width (可选) ?(可选) g(可选)

fill-and-align 和 width 的含义与标准格式规范中相同。

? 选项用于将路径名格式化为转义字符串。

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()。将 s 写入 ctx.out()，由 path-format-spec 指定。

对于路径名的字符转码

• 如果满足以下条件，则路径名从宽字符串的本机编码转码为 UTF-8，并将格式错误的子序列的最大子部分替换为 U+FFFD 替换字符：
  • 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，则不执行转码。
• 否则，转码是实现定义的。

返回一个迭代器，指向输出范围的末尾之后。

注意

特性测试 宏	值	Std	特性
__cpp_lib_format_path	202403L	(C++26)	对 std::filesystem::path 的格式化支持

参见

formatter (C++20)

定义给定类型的格式化规则 (类模板)