std::filesystem::rename

 

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

 

Definiert in Header <filesystem>
void rename( const std::filesystem::path& old_p,              const std::filesystem::path& new_p );	(1)	(seit C++17)
void rename( const std::filesystem::path& old_p,              const std::filesystem::path& new_p,              std::error_code& ec ) noexcept;	(2)	(seit C++17)

Verschiebt oder benennt das Dateisystemobjekt, das durch old_p identifiziert wird, nach new_p um, als ob dies durch den POSIX rename-Aufruf geschehen wäre.

• Wenn old_p eine Nicht-Verzeichnis-Datei ist, muss new_p eine der folgenden Bedingungen erfüllen:

• dasselbe Datei wie old_p oder ein Hardlink dazu: In diesem Fall wird nichts unternommen.
• eine existierende Nicht-Verzeichnis-Datei: new_p wird zuerst gelöscht. Dann, ohne dass andere Prozesse new_p als gelöscht wahrnehmen können, wird der Pfadname new_p mit der Datei verknüpft und old_p von der Datei getrennt. Schreibberechtigungen sind sowohl für das Verzeichnis erforderlich, das old_p enthält, als auch für das Verzeichnis, das new_p enthält.
• eine nicht existierende Datei in einem existierenden Verzeichnis: Der Pfadname new_p wird mit der Datei verknüpft und old_p von der Datei getrennt. Schreibberechtigungen sind sowohl für das Verzeichnis erforderlich, das old_p enthält, als auch für das Verzeichnis, das new_p enthält.

• Wenn old_p ein Verzeichnis ist, muss new_p eine der folgenden Bedingungen erfüllen:

• dasselbe Verzeichnis wie old_p oder ein Hardlink dazu: In diesem Fall wird nichts unternommen.
• ein existierendes Verzeichnis: new_p wird auf POSIX-Systemen gelöscht, wenn es leer ist, dies kann jedoch auf anderen Systemen ein Fehler sein. Wenn es kein Fehler ist, wird new_p zuerst gelöscht. Dann, ohne dass andere Prozesse new_p als gelöscht wahrnehmen können, wird der Pfadname new_p mit dem Verzeichnis verknüpft und old_p vom Verzeichnis getrennt. Schreibberechtigungen sind sowohl für das Verzeichnis erforderlich, das old_p enthält, als auch für das Verzeichnis, das new_p enthält.
• ein nicht existierendes Verzeichnis, das nicht mit einem Verzeichnistrenner endet und dessen Elternverzeichnis existiert: Der Pfadname new_p wird mit dem Verzeichnis verknüpft und old_p vom Verzeichnis getrennt. Schreibberechtigungen sind sowohl für das Verzeichnis erforderlich, das old_p enthält, als auch für das Verzeichnis, das new_p enthält.

• Symlinks werden nicht verfolgt: Wenn old_p ein Symlink ist, wird er selbst umbenannt, nicht sein Ziel. Wenn new_p ein existierender Symlink ist, wird er selbst gelöscht, nicht sein Ziel.

Das Umbenennen schlägt fehl, wenn

• new_p mit einem Punkt (dot) oder einem Doppelpunkt (dot-dot) endet.
• new_p ein nicht existierendes Verzeichnis bezeichnet, das mit einem Verzeichnistrenner endet.
• old_p ein Verzeichnis ist, das ein Vorfahre von new_p ist.

Parameter

old_p	-	Pfad, der verschoben oder umbenannt werden soll
new_p	-	Zielpfad für die Verschiebe-/Umbenennungsoperation
ec	-	Ausgabeparameter für die Fehlerberichterstattung in der nicht auslösenden Überladung

Rückgabewert

(keine)

Ausnahmen

Jede Überladung, die nicht als noexcept markiert ist, kann std::bad_alloc auslösen, wenn die Speicherzuweisung fehlschlägt.

1) Wirft std::filesystem::filesystem_error bei Fehlern der zugrundeliegenden OS-API. Die Ausnahme wird mit old_p als erstes Pfadargument, new_p als zweites Pfadargument und dem OS-Fehlercode als Fehlercodeargument konstruiert.

2) Setzt einen std::error_code& Parameter auf den Betriebssystem-API-Fehlercode, wenn ein Betriebssystem-API-Aufruf fehlschlägt, und führt ec.clear() aus, wenn keine Fehler auftreten.

Beispiel

Führen Sie diesen Code aus

#include <filesystem>
#include <fstream>
namespace fs = std::filesystem;
 
int main()
{
    std::filesystem::path p = std::filesystem::current_path() / "sandbox";
    std::filesystem::create_directories(p / "from");
    std::ofstream{ p / "from/file1.txt" }.put('a');
    std::filesystem::create_directory(p / "to");
 
//  fs::rename(p / "from/file1.txt", p / "to/"); // error: "to" is a directory
    fs::rename(p / "from/file1.txt", p / "to/file2.txt"); // OK
//  fs::rename(p / "from", p / "to"); // error: "to" is not empty
    fs::rename(p / "from", p / "to/subdir"); // OK
 
    std::filesystem::remove_all(p);
}

Siehe auch

rename	benennt eine Datei um (function)
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)