std::filesystem::status, std::filesystem::symlink_status

 

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>
std::filesystem::file_status status( const std::filesystem::path& p );	(1)	(seit C++17)
std::filesystem::file_status status( const std::filesystem::path& p,                                      std::error_code& ec ) noexcept;	(2)	(seit C++17)
std::filesystem::file_status symlink_status( const std::filesystem::path& p );	(3)	(seit C++17)
std::filesystem::file_status symlink_status( const std::filesystem::path& p,                                              std::error_code& ec ) noexcept;	(4)	(seit C++17)

1,2) Ermittelt den Typ und die Attribute des Dateisystemobjekts, das durch p identifiziert wird, als ob durch POSIX stat (Symlinks werden zu ihren Zielen verfolgt). In der folgenden Beschreibung ist prms das Ergebnis von (m & perms::mask), wobei m so erhalten wird, als ob st_mode aus der POSIX struct stat genommen und in den Typ std::filesystem::perms konvertiert wird.

• Wenn p eine reguläre Datei ist (als ob durch POSIX S_ISREG), wird file_status(file_type::regular, prms) zurückgegeben.
• Wenn p ein Verzeichnis ist (als ob durch POSIX S_ISDIR), wird file_status(file_type::directory, prms) zurückgegeben.
• Wenn p eine Block-Spezialdatei ist (als ob durch POSIX S_ISBLK), wird file_status(file_type::block, prms) zurückgegeben.
• Wenn p eine Zeichen-Spezialdatei ist (als ob durch POSIX S_ISCHR), wird file_status(file_type::character, prms) zurückgegeben.
• Wenn p eine FIFO- oder Pipe-Datei ist (als ob durch POSIX S_ISFIFO), wird file_status(file_type::fifo, prms) zurückgegeben.
• Wenn p ein Socket ist (als ob durch POSIX S_ISSOCK), wird file_status(file_type::socket, prms) zurückgegeben.
• Wenn p einen implementierungsdefinierten Dateityp hat, wird file_status(file_type::A, prms) zurückgegeben, wobei A die implementierungsdefinierte file_type-Konstante für diesen Typ ist.
• Wenn p nicht existiert, wird file_status(file_type::not_found) zurückgegeben.
• Wenn p existiert, aber die Dateiattribute nicht ermittelt werden können, z. B. aufgrund fehlender Berechtigungen, wird file_status(file_type::unknown) zurückgegeben.
• Wenn Fehler sogar verhindern, dass festgestellt werden kann, ob p existiert, setzt die nicht werfende Überladung ec und gibt file_status(file_type::none) zurück, und die werfende Überladung wirft filesystem_error.
• Andernfalls wird file_status(file_type::unknown, prms) zurückgegeben.

3,4) Dasselbe wie (1,2), außer dass das Verhalten so ist, als ob die POSIX lstat verwendet wird (Symlinks werden nicht verfolgt).

• Wenn p ein Symlink ist, wird file_status(file_type::symlink) zurückgegeben.

Parameter

p	-	Zu untersuchender Pfad
ec	-	Ausgabeparameter für die Fehlerberichterstattung in der nicht auslösenden Überladung

Rückgabewert

Der Dateistatus (ein filesystem::file_status-Objekt).

Ausnahmen

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

1,3) Wirft std::filesystem::filesystem_error bei zugrundeliegenden OS-API-Fehlern, konstruiert mit p als erstem Pfadargument und dem OS-Fehlercode als Fehlercodeargument.

2,4) 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.

Anmerkungen

Die von dieser Funktion bereitgestellten Informationen werden normalerweise auch als Nebenprodukt der Verzeichnisiteration bereitgestellt und können über die Memberfunktionen von filesystem::directory_entry abgerufen werden. Während der Verzeichnisiteration ist ein erneuter Aufruf von status nicht erforderlich.

Beispiel

Führen Sie diesen Code aus

#include <cstdio>
#include <cstring>
#include <filesystem>
#include <fstream>
#include <iostream>
#include <sys/socket.h>
#include <sys/stat.h>
#include <sys/un.h>
#include <unistd.h>
 
namespace fs = std::filesystem;
 
void demo_status(const fs::path& p, fs::file_status s)
{
    std::cout << p;
    // alternative: switch(s.type()) { case fs::file_type::regular: ...}
    if (fs::is_regular_file(s))
        std::cout << " is a regular file\n";
    if (fs::is_directory(s))
        std::cout << " is a directory\n";
    if (fs::is_block_file(s))
        std::cout << " is a block device\n";
    if (fs::is_character_file(s))
        std::cout << " is a character device\n";
    if (fs::is_fifo(s))
        std::cout << " is a named IPC pipe\n";
    if (fs::is_socket(s))
        std::cout << " is a named IPC socket\n";
    if (fs::is_symlink(s))
        std::cout << " is a symlink\n";
    if (!fs::exists(s))
        std::cout << " does not exist\n";
}
 
int main()
{
    // create files of different kinds
    fs::create_directory("sandbox");
    fs::create_directory("sandbox/dir");
    std::ofstream{"sandbox/file"}; // create regular file
    fs::create_symlink("file", "sandbox/symlink");
 
    mkfifo("sandbox/pipe", 0644);
    sockaddr_un addr;
    addr.sun_family = AF_UNIX;
    std::strcpy(addr.sun_path, "sandbox/sock");
    int fd = socket(PF_UNIX, SOCK_STREAM, 0);
    bind(fd, reinterpret_cast<sockaddr*>(&addr), sizeof addr);
 
    // demo different status accessors
    for (auto it{fs::directory_iterator("sandbox")}; it != fs::directory_iterator(); ++it)
        demo_status(*it, it->symlink_status()); // use cached status from directory entry
    demo_status("/dev/null", fs::status("/dev/null")); // direct calls to status
    demo_status("/dev/sda", fs::status("/dev/sda"));
    demo_status("sandbox/no", fs::status("/sandbox/no"));
 
    // cleanup (prefer std::unique_ptr-based custom deleters)
    close(fd);
    fs::remove_all("sandbox");
}

Mögliche Ausgabe

"sandbox/file" is a regular file
"sandbox/dir" is a directory
"sandbox/pipe" is a named IPC pipe
"sandbox/sock" is a named IPC socket
"sandbox/symlink" is a symlink
"/dev/null" is a character device
"/dev/sda" is a block device
"sandbox/no" does not exist

Siehe auch

file_status (C++17)	repräsentiert Dateityp und Berechtigungen (Klasse)
status_known (C++17)	prüft, ob der Dateistatus bekannt ist (Funktion)
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_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)
exists (C++17)	prüft, ob ein Pfad auf ein existierendes Dateisystemobjekt verweist (Funktion)
statussymlink_status	Status der Datei, auf die dieser Verzeichniseintrag verweist; Status der Datei/des Symlinks, auf die/den dieser Verzeichniseintrag verweist (public member function of std::filesystem::directory_entry)