std::filesystem::relative, std::filesystem::proximate

 

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>
path relative( const std::filesystem::path& p,                std::error_code& ec );	(1)	(seit C++17)
path relative( const std::filesystem::path& p,                const std::filesystem::path& base = std::filesystem::current_path() );	(2)	(seit C++17)
path relative( const std::filesystem::path& p,                const std::filesystem::path& base,                std::error_code& ec );	(3)	(seit C++17)
path proximate( const std::filesystem::path& p,                 std::error_code& ec );	(4)	(seit C++17)
path proximate( const std::filesystem::path& p,                 const std::filesystem::path& base = std::filesystem::current_path() );	(5)	(seit C++17)
path proximate( const std::filesystem::path& p,                 const std::filesystem::path& base,                 std::error_code& ec );	(6)	(seit C++17)

1) Gibt relative(p, current_path(), ec) zurück.

2,3) Gibt p relativ zu base zurück. Löst Symlinks auf und normalisiert sowohl p als auch base vor der weiteren Verarbeitung. Gibt effektiv std::filesystem::weakly_canonical(p).lexically_relative(std::filesystem::weakly_canonical(base)) oder std::filesystem::weakly_canonical(p, ec).lexically_relative(std::filesystem::weakly_canonical(base, ec)) zurück, mit der Ausnahme, dass die Fehlercode-Form bei erstem Fehler path() zurückgibt, falls vorhanden.

4) Gibt proximate(p, current_path(), ec) zurück.

5,6) Gibt effektiv std::filesystem::weakly_canonical(p).lexically_proximate(std::filesystem::weakly_canonical(base)) oder std::filesystem::weakly_canonical(p, ec).lexically_proximate(std::filesystem::weakly_canonical(base, ec)) zurück, mit der Ausnahme, dass die Fehlercode-Form bei erstem Fehler path() zurückgibt, falls vorhanden.

Parameter

p	-	ein existierender Pfad
base	-	Basis-Pfad, relativ zu dem p relativ/proximativ gemacht wird
ec	-	Fehlercode, in dem der Fehlerstatus gespeichert wird

Rückgabewert

1) p relativ zu current_path() gemacht.

2,3) p relativ zu base gemacht.

4) p proximativ zu current_path() gemacht.

5,6) p proximativ zu base gemacht.

Ausnahmen

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

2,5) Wirft std::filesystem::filesystem_error bei zugrundeliegenden OS-API-Fehlern, konstruiert mit p als erstem Pfadargument, base als zweitem Pfadargument und dem OS-Fehlercode als Fehlercode-Argument.

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

Beispiel

Führen Sie diesen Code aus

#include <filesystem>
#include <iostream>
 
void show(std::filesystem::path x, std::filesystem::path y)
{
    std::cout << "x:\t\t " << x << "\ny:\t\t " << y << '\n'
              << "relative(x, y):  "
              << std::filesystem::relative(x, y) << '\n'
              << "proximate(x, y): "
              << std::filesystem::proximate(x, y) << "\n\n";
}
 
int main()
{
    show("/a/b/c", "/a/b");
    show("/a/c", "/a/b");
    show("c", "/a/b");
    show("/a/b", "c");
}

Mögliche Ausgabe

x:               "/a/b/c"
y:               "/a/b"
relative(x, y):  "c"
proximate(x, y): "c"
 
x:               "/a/c"
y:               "/a/b"
relative(x, y):  "../c"
proximate(x, y): "../c"
 
x:               "c"
y:               "/a/b"
relative(x, y):  ""
proximate(x, y): "c"
 
x:               "/a/b"
y:               "c"
relative(x, y):  ""
proximate(x, y): "/a/b"

Siehe auch

path (C++17)	repräsentiert einen Pfad (Klasse)
absolute (C++17)	komponiert einen absoluten Pfad (Funktion)
canonicalweakly_canonical (C++17)	komponiert einen kanonischen Pfad (Funktion)
lexically_normallexically_relativelexically_proximate	konvertiert Pfad in Normalform konvertiert Pfad in relative Form konvertiert Pfad in proximative Form (member function von std::filesystem::path)