标准库头文件 <filesystem>

来自cppreference.com
< cpp‎ | header
 
 
 

此头文件是文件系统支持库的一部分。

定义于命名空间 filesystem

目录

(C++17)
表示一个路径
(类) [编辑]
文件系统错误时抛出的异常
(类) [编辑]
目录条目
(类) [编辑]
指向目录内容的迭代器
(类) [编辑]
指向一个目录及其子目录内容的迭代器
(类) [编辑]
表示文件类型及权限
(类) [编辑]
关于文件系统上空闲及可用空间的信息
(类) [编辑]
(C++17)
文件的类型
(枚举) [编辑]
(C++17)
标识文件系统权限
(枚举) [编辑]
指定权限操作的语义
(枚举) [编辑]
指定复制操作的语义
(枚举) [编辑]
迭代目录内容的选项
(枚举) [编辑]
表示文件时间值
(typedef) [编辑]

函数

(C++17)
从 UTF-8 编码源创建 path
(函数) [编辑]
(C++17)
组成一个绝对路径
(函数) [编辑]
组成一个规范路径
(函数) [编辑]
组成一个相对路径
(函数) [编辑]
(C++17)
复制文件或目录
(函数) [编辑]
(C++17)
复制文件内容
(函数) [编辑]
复制一个符号链接
(函数) [编辑]
创建新目录
(函数) [编辑]
创建一个硬链接
(函数) [编辑]
创建一个符号链接
(函数) [编辑]
返回或设置当前工作目录
(函数) [编辑]
(C++17)
检查路径是否表示既存的文件系统对象
(函数) [编辑]
检查二个路径是否表示同一文件系统对象
(函数) [编辑]
(C++17)
返回文件的大小
(函数) [编辑]
返回引用到指定文件的硬链接数
(函数) [编辑]
获取或设置最近一次数据修改的时间
(函数) [编辑]
修改文件访问权限
(函数) [编辑]
获得符号链接的目标
(函数) [编辑]
(C++17)
(C++17)
移除一个文件或空目录
移除一个文件或递归地移除一个目录及其所有内容
(函数) [编辑]
(C++17)
移动或重命名一个文件或目录
(函数) [编辑]
以截断或填充零更改一个常规文件的大小
(函数) [编辑]
(C++17)
确定文件系统上的可用空闲空间
(函数) [编辑]
(C++17)
(C++17)
确定文件属性
确定文件属性,检查符号链接对象
(函数) [编辑]
返回一个适用于临时文件的目录
(函数) [编辑]
文件类型
检查给定的路径是否表示阻塞设备
(函数) [编辑]
检查给定的路径是否表示字符设备
(函数) [编辑]
检查给定的路径是否表示一个目录
(函数) [编辑]
(C++17)
检查给定的路径是否表示一个空文件或空目录
(函数) [编辑]
(C++17)
检查给定的路径是否表示一个具名管道
(函数) [编辑]
(C++17)
检查参数是否表示一个其他文件
(函数) [编辑]
检查参数是否表示一个常规文件
(函数) [编辑]
(C++17)
检查参数是否表示一个具名 IPC 接头
(函数) [编辑]
检查参数是否表示一个符号链接
(函数) [编辑]
检查文件状态是否已知
(函数) [编辑]

[编辑] 概要

namespace std::filesystem {
  // 路径
  class path;
  // path 非成员函数
  void swap(path& lhs, path& rhs) noexcept;
  size_t hash_value(const path& p) noexcept;
  bool operator==(const path& lhs, const path& rhs) noexcept;
  bool operator!=(const path& lhs, const path& rhs) noexcept;
  bool operator< (const path& lhs, const path& rhs) noexcept;
  bool operator<=(const path& lhs, const path& rhs) noexcept;
  bool operator> (const path& lhs, const path& rhs) noexcept;
  bool operator>=(const path& lhs, const path& rhs) noexcept;
  path operator/ (const path& lhs, const path& rhs);
  // 路径输入器与输出器
  template <class charT, class traits>
  basic_ostream<charT, traits>&
    operator<<(basic_ostream<charT, traits>& os, const path& p);
  template <class charT, class traits>
  basic_istream<charT, traits>&
    operator>>(basic_istream<charT, traits>& is, path& p);
  // 路径工厂函数
  template <class Source>
  path u8path(const Source& source);
  template <class InputIterator>
  path u8path(InputIterator first, InputIterator last);
  // 文件系统错误
  class filesystem_error;
  // 目录条目
  class directory_entry;
  // 目录迭代器
  class directory_iterator;
  // 目录迭代器的范围访问
  directory_iterator begin(directory_iterator iter) noexcept;
  directory_iterator end(const directory_iterator&) noexcept;
  // 递归目录迭代器
  class recursive_directory_iterator;
  // 递归目录迭代器的范围访问
  recursive_directory_iterator begin(recursive_directory_iterator iter) noexcept;
  recursive_directory_iterator end(const recursive_directory_iterator&) noexcept;
  // 文件状态
  class file_status;
  struct space_info {
    uintmax_t capacity;
    uintmax_t free;
    uintmax_t available;
  };
  // 枚举
  enum class file_type;
  enum class perms;
  enum class perm_options;
  enum class copy_options;
  enum class directory_options;
  using file_time_type = chrono::time_point<trivial-clock >;
  // 文件系统操作
  path absolute(const path& p, const path& base = current_path());
  path canonical(const path& p, const path& base = current_path());
  path canonical(const path& p, error_code& ec);
  path canonical(const path& p, const path& base, error_code& ec);
  void copy(const path& from, const path& to);
  void copy(const path& from, const path& to, error_code& ec) noexcept;
  void copy(const path& from, const path& to, copy_options options);
  void copy(const path& from, const path& to, copy_options options,
            error_code& ec) noexcept;
  bool copy_file(const path& from, const path& to);
  bool copy_file(const path& from, const path& to, error_code& ec) noexcept;
  bool copy_file(const path& from, const path& to, copy_options option);
  bool copy_file(const path& from, const path& to, copy_options option,
                 error_code& ec) noexcept;
  void copy_symlink(const path& existing_symlink, const path& new_symlink);
  void copy_symlink(const path& existing_symlink, const path& new_symlink,
                    error_code& ec) noexcept;
  bool create_directories(const path& p);
  bool create_directories(const path& p, error_code& ec) noexcept;
  bool create_directory(const path& p);
  bool create_directory(const path& p, error_code& ec) noexcept;
  bool create_directory(const path& p, const path& attributes);
  bool create_directory(const path& p, const path& attributes,
                        error_code& ec) noexcept;
  void create_directory_symlink(const path& to, const path& new_symlink);
  void create_directory_symlink(const path& to, const path& new_symlink,
                                error_code& ec) noexcept;
  void create_hard_link(const path& to, const path& new_hard_link);
  void create_hard_link(const path& to, const path& new_hard_link,
                        error_code& ec) noexcept;
  void create_symlink(const path& to, const path& new_symlink);
  void create_symlink(const path& to, const path& new_symlink,
                      error_code& ec) noexcept;
  path current_path();
  path current_path(error_code& ec);
  void current_path(const path& p);
  void current_path(const path& p, error_code& ec) noexcept;
  bool exists(file_status s) noexcept;
  bool exists(const path& p);
  bool exists(const path& p, error_code& ec) noexcept;
  bool equivalent(const path& p1, const path& p2);
  bool equivalent(const path& p1, const path& p2, error_code& ec) noexcept;
  uintmax_t file_size(const path& p);
  uintmax_t file_size(const path& p, error_code& ec) noexcept;
  uintmax_t hard_link_count(const path& p);
  uintmax_t hard_link_count(const path& p, error_code& ec) noexcept;
  bool is_block_file(file_status s) noexcept;
  bool is_block_file(const path& p);
  bool is_block_file(const path& p, error_code& ec) noexcept;
  bool is_character_file(file_status s) noexcept;
  bool is_character_file(const path& p);
  bool is_character_file(const path& p, error_code& ec) noexcept;
  bool is_directory(file_status s) noexcept;
  bool is_directory(const path& p);
  bool is_directory(const path& p, error_code& ec) noexcept;
  bool is_empty(const path& p);
  bool is_empty(const path& p, error_code& ec) noexcept;
  bool is_fifo(file_status s) noexcept;
  bool is_fifo(const path& p);
  bool is_fifo(const path& p, error_code& ec) noexcept;
  bool is_other(file_status s) noexcept;
  bool is_other(const path& p);
  bool is_other(const path& p, error_code& ec) noexcept;
  bool is_regular_file(file_status s) noexcept;
  bool is_regular_file(const path& p);
  bool is_regular_file(const path& p, error_code& ec) noexcept;
  bool is_socket(file_status s) noexcept;
  bool is_socket(const path& p);
  bool is_socket(const path& p, error_code& ec) noexcept;
  bool is_symlink(file_status s) noexcept;
  bool is_symlink(const path& p);
  bool is_symlink(const path& p, error_code& ec) noexcept;
  file_time_type last_write_time(const path& p);
  file_time_type last_write_time(const path& p, error_code& ec) noexcept;
  void last_write_time(const path& p, file_time_type new_time);
  void last_write_time(const path& p, file_time_type new_time,
                       error_code& ec) noexcept;
  void permissions(const path& p, perms prms,
                   perm_options opts = perm_options::replace);
  void permissions(const path& p, perms prms, error_code& ec) noexcept;
  void permissions(const path& p, perms prms,
                   perm_options opts, error_code& ec) noexcept;
  path proximate(const path& p, error_code& ec);
  path proximate(const path& p, const path& base = current_path());
  path proximate(const path& p, const path& base, error_code& ec);
  path read_symlink(const path& p);
  path read_symlink(const path& p, error_code& ec);
  path relative(const path& p, error_code& ec);
  path relative(const path& p, const path& base = current_path());
  path relative(const path& p, const path& base, error_code& ec);
  bool remove(const path& p);
  bool remove(const path& p, error_code& ec) noexcept;
  uintmax_t remove_all(const path& p);
  uintmax_t remove_all(const path& p, error_code& ec) noexcept;
  void rename(const path& from, const path& to);
  void rename(const path& from, const path& to, error_code& ec) noexcept;
  void resize_file(const path& p, uintmax_t size);
  void resize_file(const path& p, uintmax_t size, error_code& ec) noexcept;
  space_info space(const path& p);
  space_info space(const path& p, error_code& ec) noexcept;
  file_status status(const path& p);
  file_status status(const path& p, error_code& ec) noexcept;
  bool status_known(file_status s) noexcept;
  file_status symlink_status(const path& p);
  file_status symlink_status(const path& p, error_code& ec) noexcept;
  path temp_directory_path();
  path temp_directory_path(error_code& ec);
  path weakly_canonical(const path& p);
  path weakly_canonical(const path& p, error_code& ec);
}

[编辑] std::filesystem::path

class path {
public:
  using value_type = /*see definition*/ ;
  using string_type = basic_string<value_type>;
  static constexpr value_type preferred_separator = /*see definition*/ ;
  // 枚举
  enum format {
    native_format,
    generic_format,
    auto_format
  };
  // 构造函数与析构函数
  path() noexcept;
  path(const path& p);
  path(path&& p) noexcept;
  path(string_type&& source, format = auto_format);
  template <class Source>
  path(const Source& source, format = auto_format);
  template <class InputIterator>
  path(InputIterator first, InputIterator last, format = auto_format);
  template <class Source>
  path(const Source& source, const locale& loc, format = auto_format);
  template <class InputIterator>
  path(InputIterator first, InputIterator last,
       const locale& loc, format = auto_format);
  ~path();
  // 赋值
  path& operator=(const path& p);
  path& operator=(path&& p) noexcept;
  path& operator=(string_type&& source);
  path& assign(string_type&& source);
  template <class Source>
  path& operator=(const Source& source);
  template <class Source>
  path& assign(const Source& source)
  template <class InputIterator>
  path& assign(InputIterator first, InputIterator last);
  // 附加
  path& operator/=(const path& p);
  template <class Source>
  path& operator/=(const Source& source);
  template <class Source>
  path& append(const Source& source);
  template <class InputIterator>
  path& append(InputIterator first, InputIterator last);
  // 连接
  path& operator+=(const path& x);
  path& operator+=(const string_type& x);
  path& operator+=(basic_string_view<value_type> x);
  path& operator+=(const value_type* x);
  path& operator+=(value_type x);
  template <class Source>
  path& operator+=(const Source& x);
  template <class EcharT>
  path& operator+=(EcharT x);
  template <class Source>
  path& concat(const Source& x);
  template <class InputIterator>
  path& concat(InputIterator first, InputIterator last);
  // 修改器
  void clear() noexcept;
  path& make_preferred();
  path& remove_filename();
  path& replace_filename(const path& replacement);
  path& replace_extension(const path& replacement = path());
  void swap(path& rhs) noexcept;
  // 原生格式观察器
  const string_type& native() const noexcept;
  const value_type* c_str() const noexcept;
  operator string_type() const;
  template <class EcharT, class traits = char_traits<EcharT>,
            class Allocator = allocator<EcharT>>
  basic_string<EcharT, traits, Allocator>
    string(const Allocator& a = Allocator()) const;
  std::string string() const;
  std::wstring wstring() const;
  std::string u8string() const;
  std::u16string u16string() const;
  std::u32string u32string() const;
  // 通用格式观察器
  template <class EcharT, class traits = char_traits<EcharT>,
            class Allocator = allocator<EcharT>>
  basic_string<EcharT, traits, Allocator>
    generic_string(const Allocator& a = Allocator()) const;
  std::string generic_string() const;
  std::wstring generic_wstring() const;
  std::string generic_u8string() const;
  std::u16string generic_u16string() const;
  std::u32string generic_u32string() const;
  // 比较
  int compare(const path& p) const noexcept;
  int compare(const string_type& s) const;
  int compare(basic_string_view<value_type> s) const;
  int compare(const value_type* s) const;
  // 分解
  path root_name() const;
  path root_directory() const;
  path root_path() const;
  path relative_path() const;
  path parent_path() const;
  path filename() const;
  path stem() const;
  path extension() const;
  // 查询
  bool empty() const noexcept;
  bool has_root_name() const;
  bool has_root_directory() const;
  bool has_root_path() const;
  bool has_relative_path() const;
  bool has_parent_path() const;
  bool has_filename() const;
  bool has_stem() const;
  bool has_extension() const;
  bool is_absolute() const;
  bool is_relative() const;
  // 生成
  path lexically_normal() const;
  path lexically_relative(const path& base) const;
  path lexically_proximate(const path& base) const;
  // 迭代器
  class iterator;
  using const_iterator = iterator;
  iterator begin() const;
  iterator end() const;
private:
  string_type pathstring; // 仅为说明
};

[编辑] std::filesystem::filesystem_error

class filesystem_error : public system_error {
public:
  filesystem_error(const string& what_arg, error_code ec);
  filesystem_error(const string& what_arg,
                   const path& p1, error_code ec);
  filesystem_error(const string& what_arg,
                   const path& p1, const path& p2, error_code ec);
  const path& path1() const noexcept;
  const path& path2() const noexcept;
  const char* what() const noexcept override;
};

[编辑] std::filesystem::file_status

class file_status {
public:
  // 构造函数与析构函数]
  explicit file_status(file_type ft = file_type::none,
                       perms prms = perms::unknown) noexcept;
  file_status(const file_status&) noexcept = default;
  file_status(file_status&&) noexcept = default;
  ~file_status();
  // 赋值
  file_status& operator=(const file_status&) noexcept = default;
  file_status& operator=(file_status&&) noexcept = default;
  // 修改器
  void type(file_type ft) noexcept;
  void permissions(perms prms) noexcept;
  // 观察器
  file_type type() const noexcept;
  perms permissions() const noexcept;
};

[编辑] std::directory_entry

class directory_entry {
public:
  // constructors and destructor
  explicit directory_entry(const path& p);
  directory_entry() noexcept = default;
  directory_entry(const directory_entry&) = default;
  directory_entry(directory_entry&&) noexcept = default;
  ~directory_entry();
  // 赋值
  directory_entry& operator=(const directory_entry&) = default;
  directory_entry& operator=(directory_entry&&) noexcept = default;
  // 修改器
  void assign(const path& p);
  void replace_filename(const path& p);
  // 观察器
  const path& path() const noexcept;
  operator const path&() const noexcept;
  file_status status() const;
  file_status status(error_code& ec) const noexcept;
  file_status symlink_status() const;
  file_status symlink_status(error_code& ec) const noexcept;
  bool operator< (const directory_entry& rhs) const noexcept;
  bool operator==(const directory_entry& rhs) const noexcept;
  bool operator!=(const directory_entry& rhs) const noexcept;
  bool operator<=(const directory_entry& rhs) const noexcept;
  bool operator> (const directory_entry& rhs) const noexcept;
  bool operator>=(const directory_entry& rhs) const noexcept;
private:
  path pathobject; // 仅为说明
};

[编辑] std::filesystem::directory_iterator

class directory_iterator {
public:
  using iterator_category = input_iterator_tag;
  using value_type = directory_entry;
  using difference_type = ptrdiff_t;
  using pointer = const directory_entry*;
  using reference = const directory_entry&;
  // 成员函数
  directory_iterator() noexcept;
  explicit directory_iterator(const path& p);
  directory_iterator(const path& p, directory_options options);
  directory_iterator(const path& p, error_code& ec) noexcept;
  directory_iterator(const path& p, directory_options options,
                     error_code& ec) noexcept;
  directory_iterator(const directory_iterator& rhs);
  directory_iterator(directory_iterator&& rhs) noexcept;
  ~directory_iterator();
  directory_iterator& operator=(const directory_iterator& rhs);
  directory_iterator& operator=(directory_iterator&& rhs) noexcept;
  const directory_entry& operator*() const;
  const directory_entry* operator->() const;
  directory_iterator& operator++();
  directory_iterator& increment(error_code& ec) noexcept;
  // 其他作为输入迭代器所要求的成员
};

[编辑] std::filesystem::recursive_directory_iterator

class recursive_directory_iterator {
public:
  using iterator_category = input_iterator_tag;
  using value_type = directory_entry;
  using difference_type = ptrdiff_t;
  using pointer = const directory_entry*;
  using reference = const directory_entry&;
  // 构造函数与析构函数
  recursive_directory_iterator() noexcept;
  explicit recursive_directory_iterator(const path& p);
  recursive_directory_iterator(const path& p, directory_options options);
  recursive_directory_iterator(const path& p, directory_options options,
                               error_code& ec) noexcept;
  recursive_directory_iterator(const path& p, error_code& ec) noexcept;
  recursive_directory_iterator(const recursive_directory_iterator& rhs);
  recursive_directory_iterator(recursive_directory_iterator&& rhs) noexcept;
  ~recursive_directory_iterator();
  // 观察器
  directory_options options() const;
  int depth() const;
  bool recursion_pending() const;
  const directory_entry& operator*() const;
  const directory_entry* operator->() const;
  // 修改器
  recursive_directory_iterator&
  operator=(const recursive_directory_iterator& rhs);
  recursive_directory_iterator&
  operator=(recursive_directory_iterator&& rhs) noexcept;
  recursive_directory_iterator& operator++();
  recursive_directory_iterator& increment(error_code& ec) noexcept;
  void pop();
  void pop(error_code& ec);
  void disable_recursion_pending();
  // 其他作为输入迭代器所要求的成员
};