Dateisystem-Bibliothek (seit C++17)

 

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

Dateisystem-Bibliothek (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

 

Die Dateisystem-Bibliothek bietet Einrichtungen zur Durchführung von Operationen auf Dateisystemen und deren Komponenten, wie z. B. Pfaden, regulären Dateien und Verzeichnissen.

Die Dateisystem-Bibliothek wurde ursprünglich als boost.filesystem entwickelt, wurde als technische Spezifikation ISO/IEC TS 18822:2015 veröffentlicht und schließlich mit C++17 in den ISO C++-Standard aufgenommen. Die Boost-Implementierung ist derzeit auf mehr Compilern und Plattformen verfügbar als die C++17-Bibliothek.

Die Einrichtungen der Dateisystem-Bibliothek sind möglicherweise nicht verfügbar, wenn ein hierarchisches Dateisystem für die Implementierung nicht zugänglich ist oder die notwendigen Fähigkeiten nicht bereitstellt. Einige Funktionen sind möglicherweise nicht verfügbar, wenn sie vom zugrunde liegenden Dateisystem nicht unterstützt werden (z. B. fehlt dem FAT-Dateisystem symbolische Links und es sind keine mehreren Hardlinks zulässig). In solchen Fällen müssen Fehler gemeldet werden.

Das Verhalten ist undefiniert, wenn Aufrufe von Funktionen in dieser Bibliothek zu einem Dateisystem-Race führen, d. h. wenn mehrere Threads, Prozesse oder Computer den Zugriff und die Modifikation desselben Objekts in einem Dateisystem miteinander verschachteln.

Bibliotheksweite Definitionen

• Datei: ein Dateisystemobjekt, das Daten enthält und auf das geschrieben, von dem gelesen oder beides werden kann. Dateien haben Namen, Attribute, von denen eines der Dateityp ist.

• Verzeichnis: eine Datei, die als Container für Verzeichniseinträge fungiert, welche andere Dateien identifizieren (von denen einige andere, verschachtelte Verzeichnisse sein können). Wenn über eine bestimmte Datei gesprochen wird, ist das Verzeichnis, in dem sie als Eintrag erscheint, ihr übergeordnetes Verzeichnis. Das übergeordnete Verzeichnis kann durch den relativen Pfadnamen ".." dargestellt werden.
• reguläre Datei: ein Verzeichniseintrag, der einen Namen mit einer vorhandenen Datei (d. h. einem Hardlink) verknüpft. Wenn mehrere Hardlinks unterstützt werden, wird die Datei nach dem Entfernen des letzten Hardlinks zu ihr gelöscht.
• symbolischer Link: ein Verzeichniseintrag, der einen Namen mit einem Pfad verknüpft, der existieren kann oder auch nicht.
• andere spezielle Dateitypen: Block, Zeichen, FIFO, Socket.

• Dateiname: eine Zeichenkette, die eine Datei benennt. Zulässige Zeichen, Groß-/Kleinschreibung, maximale Länge und nicht zulässige Namen sind implementierungsabhängig. Die Namen "." (Punkt) und ".." (Punkt-Punkt) haben auf Bibliotheksebene eine besondere Bedeutung.
• Pfad: eine Sequenz von Elementen, die eine Datei identifiziert. Er beginnt mit einem optionalen Root-Namen (z. B. "C:" oder "//server" unter Windows), gefolgt von einem optionalen Root-Verzeichnis (z. B. "/" unter Unix), gefolgt von einer Sequenz von null oder mehr Dateinamen (alle außer dem letzten müssen Verzeichnisse oder Links zu Verzeichnissen sein). Das native Format (z. B. welche Zeichen als Trennzeichen verwendet werden) und die Zeichenkodierung der String-Repräsentation eines Pfades (des Pfadnamens) sind implementierungsabhängig; diese Bibliothek bietet eine portable Darstellung von Pfaden.

• absoluter Pfad: ein Pfad, der den Speicherort einer Datei eindeutig identifiziert.
• kanonischer Pfad: ein absoluter Pfad, der keine symbolischen Links, "."- oder ".."-Elemente enthält.
• relativer Pfad: ein Pfad, der den Speicherort einer Datei relativ zu einem Speicherort im Dateisystem identifiziert. Die speziellen Pfadnamen "." (Punkt, "aktuelles Verzeichnis") und ".." (Punkt-Punkt, "übergeordnetes Verzeichnis") sind relative Pfade.

Klassen
Definiert in Header <filesystem>
Definiert im Namespace std::filesystem
path (C++17)	repräsentiert einen Pfad (Klasse)
filesystem_error (C++17)	eine Ausnahme, die bei Dateisystemfehlern ausgelöst wird (Klasse)
directory_entry (C++17)	ein Verzeichniseintrag (Klasse)
directory_iterator (C++17)	ein Iterator für den Inhalt des Verzeichnisses (Klasse)
recursive_directory_iterator (C++17)	ein Iterator für den Inhalt eines Verzeichnisses und seiner Unterverzeichnisse (Klasse)
file_status (C++17)	repräsentiert Dateityp und Berechtigungen (Klasse)
space_info (C++17)	Informationen über freien und verfügbaren Speicherplatz auf dem Dateisystem (Klasse)
file_type (C++17)	der Typ einer Datei (Enum)
perms (C++17)	identifiziert Dateisystemberechtigungen (Enum)
perm_options (C++17)	spezifiziert die Semantik von Berechtigungsoperationen (Enum)
copy_options (C++17)	spezifiziert die Semantik von Kopiervorgängen (Enum)
directory_options (C++17)	Optionen für das Iterieren über Verzeichnisinhalte (Enum)
file_time_type (C++17)	repräsentiert Datei-Zeitwerte (Typedef)
Nicht-Member-Funktionen
Definiert in Header <filesystem>
Definiert im Namespace std::filesystem
absolute (C++17)	komponiert einen absoluten Pfad (Funktion)
canonicalweakly_canonical (C++17)	komponiert einen kanonischen Pfad (Funktion)
relativeproximate (C++17)	komponiert einen relativen Pfad (Funktion)
copy (C++17)	kopiert Dateien oder Verzeichnisse (Funktion)
copy_file (C++17)	kopiert Dateiinhalte (Funktion)
copy_symlink (C++17)	kopiert einen symbolischen Link (Funktion)
create_directorycreate_directories (C++17)(C++17)	erstellt neues Verzeichnis (Funktion)
create_hard_link (C++17)	erstellt einen Hardlink (Funktion)
create_symlinkcreate_directory_symlink (C++17)(C++17)	erstellt einen symbolischen Link (Funktion)
current_path (C++17)	gibt das aktuelle Arbeitsverzeichnis zurück oder setzt es (Funktion)
exists (C++17)	prüft, ob ein Pfad auf ein existierendes Dateisystemobjekt verweist (Funktion)
equivalent (C++17)	prüft, ob zwei Pfade auf dasselbe Dateisystemobjekt verweisen (Funktion)
file_size (C++17)	gibt die Größe einer Datei zurück (Funktion)
hard_link_count (C++17)	gibt die Anzahl der Hardlinks zurück, die auf die spezifische Datei verweisen (Funktion)
last_write_time (C++17)	liest oder setzt die Zeit der letzten Datenmodifikation (Funktion)
permissions (C++17)	modifiziert Dateizugriffsberechtigungen (Funktion)
read_symlink (C++17)	ermittelt das Ziel eines symbolischen Links (Funktion)
removeremove_all (C++17)(C++17)	entfernt eine Datei oder ein leeres Verzeichnis entfernt eine Datei oder ein Verzeichnis und dessen gesamten Inhalt rekursiv (Funktion)
rename (C++17)	verschiebt oder benennt eine Datei oder ein Verzeichnis um (Funktion)
resize_file (C++17)	ändert die Größe einer regulären Datei durch Abschneiden oder Auffüllen mit Nullen (Funktion)
Leerzeichen (C++17)	ermittelt den verfügbaren freien Speicherplatz auf dem Dateisystem (Funktion)
statussymlink_status (C++17)(C++17)	ermittelt Dateiattribute ermittelt Dateiattribute, wobei das Ziel des symbolischen Links geprüft wird (Funktion)
temp_directory_path (C++17)	gibt ein Verzeichnis zurück, das für temporäre Dateien geeignet ist (Funktion)
Dateitypen
is_block_file (C++17)	prüft, ob der gegebene Pfad auf ein Blockgerät verweist (Funktion)
is_character_file (C++17)	prüft, ob der gegebene Pfad auf ein Zeichengerät verweist (Funktion)
is_directory (C++17)	prüft, ob der gegebene Pfad auf ein Verzeichnis verweist (Funktion)
is_empty (C++17)	prüft, ob der gegebene Pfad auf eine leere Datei oder ein leeres Verzeichnis verweist (Funktion)
is_fifo (C++17)	prüft, ob der gegebene Pfad auf eine benannte Pipe verweist (Funktion)
is_other (C++17)	prüft, ob das Argument auf eine andere Datei verweist (Funktion)
is_regular_file (C++17)	prüft, ob das Argument auf eine reguläre Datei verweist (Funktion)
is_socket (C++17)	prüft, ob das Argument auf einen benannten IPC-Socket verweist (Funktion)
is_symlink (C++17)	prüft, ob das Argument auf einen symbolischen Link verweist (Funktion)
status_known (C++17)	prüft, ob der Dateistatus bekannt ist (Funktion)

Anmerkungen

Die Verwendung dieser Bibliothek erfordert möglicherweise zusätzliche Compiler-/Linker-Optionen. Die GNU-Implementierung vor Version 9.1 erfordert das Linken mit -lstdc++fs, und die LLVM-Implementierung vor LLVM 9.0 erfordert das Linken mit -lc++fs.

Feature-Test-Makro	Wert	Std	Feature
__cpp_lib_filesystem	201703L	(C++17)	Dateisystem-Bibliothek

Siehe auch

C++ Dokumentation für File System TS