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

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

ファイルシステムライブラリ

クラス
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 クラスに対するテンプレート特殊化により、ユーザーはフォーマット関数を使用してパス名をそのテキスト表現に変換できます。この特殊化は デバッグ有効 です。

フォーマット指定子

フォーマット指定子 path-format-spec の構文は次のとおりです。

fill-and-align (任意) width (任意) ?(任意) g(任意)

fill-and-align および width は、標準フォーマット指定子と同じ意味を持ちます。

? オプションは、パス名を エスケープされた文字列としてフォーマットするために使用されます。

g オプションは、パス名が 汎用フォーマット表現であることを指定するために使用されます。

メンバ関数

set_debug_format	パス名を エスケープされた文字列としてフォーマットできるようにします。 (public member function)
parse	path-format-spec で指定されたフォーマット指定子を解析します。 (public member function)
format	path-format-spec で指定されたフォーマット済み出力を書き込みます。 (public member function)

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;

g オプションが使用されている場合は s を p.generic<std::filesystem::path::value_type>() とし、それ以外の場合は 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)

与えられた型のフォーマット規則を定義する (クラステンプレート)