Skip to content

Latest commit

 

History

History
100 lines (83 loc) · 2.73 KB

is_directory.md

File metadata and controls

100 lines (83 loc) · 2.73 KB

is_directory

  • filesystem[meta header]
  • std::filesystem[meta namespace]
  • function[meta id-type]
  • cpp17[meta cpp]
namespace std::filesystem {
  bool is_directory(file_status s) noexcept;                      // (1)
  bool is_directory(const path& p);                               // (2)
  bool is_directory(const path& p, std::error_code& ec) noexcept; // (3)
}
  • file_status[link file_status.md]
  • path[link path.md]

概要

指定されたパスがディレクトリを指しているかを確認する。

戻り値

  • (1) : return s.type() == file_type::directory;
  • (2) : return is_directory(status(p));
  • (3) :
    file_status s = status(p, ec);
    if (ec) {
      return false;
    }
    
    if (!status_known(s)) {
      ec = implementation-defined;
      return false;
    }
    ec.clear();
    return is_directory(s);
    • file_status[link file_status.md]
    • status[link status.md]
    • file_type[link file_type.md]
    • s.type()[link file_status/type.md]
    • ec.clear()[link /reference/system_error/error_code/clear.md]

例外

  • (1) : 投げない
  • (2) : ファイルシステムがエラーを報告する場合がある。それに加えて、指定されたファイルの種別がfile_type::unknownのいずれかである場合もエラーである。エラーが発生した場合は、std::filesystem::filesystem_error例外を送出する
  • (3) : 投げない

#include <cassert>
#include <fstream>
#include <filesystem>

namespace fs = std::filesystem;

int main()
{
  std::ofstream{"regular.txt"};
  fs::create_directory("dir");
  fs::create_directory_symlink("dir", "dir_symlink");

  // (1)
  // 取得済みのファイル状態を使用して、ディレクトリかを確認
  assert(fs::is_directory(fs::status("dir")));

  // (2)
  // パスを指定して、ディレクトリかを確認。
  // シンボリックリンクはリンク先ファイルで判定される
  assert(fs::is_directory("dir"));
  assert(fs::is_directory("dir_symlink"));
  assert(!fs::is_directory("regular.txt"));

  // (3)
  // エラー情報を例外ではなくerror_codeで受け取る
  std::error_code ec;
  bool result = fs::is_directory("dir", ec);
  assert(!ec);
  assert(result);
}
  • fs::is_directory[color ff0000]
  • fs::create_directory[link create_directory.md]
  • fs::create_directory_symlink[link create_directory_symlink.md]
  • fs::status[link status.md]

出力

バージョン

言語

  • C++17

処理系