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

 

C++

Compiler-Unterstützung

Freestanding und gehostet

Sprache

Standardbibliothek

Header der Standardbibliothek

Benannte Anforderungen

Feature-Test-Makros (C++20)

Bibliothek für Sprachunterstützung

Konzepte-Bibliothek (C++20)

Diagnostik-Bibliothek

Speicherverwaltungsbibliothek

Metaprogrammierungsbibliothek (C++11)

Allgemeine Dienstprogramme-Bibliothek

Container-Bibliothek

Iterator-Bibliothek

Ranges-Bibliothek (C++20)

Algorithmen-Bibliothek

Bibliothek für Zeichenketten

Textverarbeitungsbibliothek

Numerik-Bibliothek

Datums- und Zeitbibliothek

Ein-/Ausgabe-Bibliothek

Dateisystembibliothek (C++17)

Unterstützung für nebenläufige Programmierung (C++11)

Ausführungssteuerungsbibliothek (C++26)

Technische Spezifikationen

Symbolverzeichnis

Externe Bibliotheken

 

Dateisystem-Bibliothek

Klassen
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
Funktionen
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
Dateitypen
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

Membertypen
Member-Konstanten
path::native_formatpath::generic_formatpath::auto_format
Memberfunktionen
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
Pfadtrennung
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
Nicht-Member-Funktionen
operator==operator!=operator<operator<=operator>operator>=operator<=> (bis C++20)(bis C++20)(bis C++20)(bis C++20)(bis C++20)(C++20)	operator/ operator<<operator>> swap(std::filesystem::path) hash_value u8path
Hilfsklassen
hash<std::filesystem::path>	formatter<std::filesystem::path> (C++26)

 

Definiert in Header <filesystem>
template< class CharT > struct formatter<std::filesystem::path, CharT>;		(seit C++26)

Die Template-Spezialisierung von std::formatter für die std::filesystem::path Klasse erlaubt es Benutzern, einen Pfadnamen mit Formatierungsfunktionen in seine textuelle Darstellung umzuwandeln. Diese Spezialisierung ist debug-enabled.

Formatangabe

Die Syntax der Formatangaben path-format-spec lautet

fill-and-align (optional) width (optional) ?(optional) g(optional)

fill-and-align und width haben die gleiche Bedeutung wie in der Standard-Formatangabe.

Die Option ? wird verwendet, um den Pfadnamen als escaped string zu formatieren.

Die Option g wird verwendet, um anzugeben, dass der Pfadname in der generischen Formatdarstellung vorliegt.

Memberfunktionen

set_debug_format	ermöglicht die Formatierung des Pfadnamens als escaped string (öffentliche Memberfunktion)
parse	parst den Format-Spezifizierer gemäß path-format-spec (öffentliche Memberfunktion)
format	schreibt die formatierte Ausgabe gemäß path-format-spec (öffentliche Memberfunktion)

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

constexpr void set_debug_format();

Ermöglicht dem aktuellen Objekt, Pfadnamen als escaped string zu formatieren.

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

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

Parst die Format-Spezifizierer als path-format-spec und speichert die geparsten Spezifizierer im aktuellen Objekt.

Gibt einen Iterator nach dem Ende des path-format-spec zurück.

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

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

Sei s p.generic<std::filesystem::path::value_type>(), wenn die Option g verwendet wird, andernfalls p.native(). Schreibt s in ctx.out() gemäß path-format-spec.

Für die Zeichen-Transkodierung des Pfadnamens

• Der Pfadname wird von der nativen Kodierung für Weitzeichenstrings nach UTF-8 transkodiert, wobei maximale Teilteile von fehlerhaften Untersequenzen durch U+FFFD REPLACEMENT CHARACTER ersetzt werden, wenn
  • std::is_same_v<CharT, char> true ist,
  • std::is_same_v<typename path::value_type, wchar_t> true ist und
  • die übliche Literal-Kodierung UTF-8 ist.
• Andernfalls erfolgt keine Transkodierung, wenn std::is_same_v<typename path::value_type, CharT> true ist.
• Andernfalls ist die Transkodierung implementierungsabhängig.

Gibt einen Iterator nach dem Ende des Ausgabe-Bereichs zurück.

Hinweise

Feature-Test-Makro	Wert	Std	Feature
__cpp_lib_format_path	202403L	(C++26)	Formatierungsunterstützung für std::filesystem::path

Siehe auch

formatter (C++20)

definiert Formatierungsregeln für einen gegebenen Typ (Klassentemplate)